InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-instance

Initializer

import com.aliyun.ros.cdk.ecs.InstanceProps;
InstanceProps.builder()
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
//  .affinity(java.lang.String)
//  .affinity(IResolvable)
//  .allocatePublicIp(java.lang.Boolean)
//  .allocatePublicIp(IResolvable)
//  .autoRenew(java.lang.String)
//  .autoRenew(IResolvable)
//  .autoRenewPeriod(java.lang.Number)
//  .autoRenewPeriod(IResolvable)
//  .creditSpecification(java.lang.String)
//  .creditSpecification(IResolvable)
//  .dedicatedHostId(java.lang.String)
//  .dedicatedHostId(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .deploymentSetGroupNo(java.lang.Number)
//  .deploymentSetGroupNo(IResolvable)
//  .deploymentSetId(java.lang.String)
//  .deploymentSetId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskMappings(IResolvable)
//  .diskMappings(java.util.List<IResolvable)
//  .diskMappings(DiskMappingsProperty>)
//  .hostName(java.lang.String)
//  .hostName(IResolvable)
//  .hpcClusterId(java.lang.String)
//  .hpcClusterId(IResolvable)
//  .httpEndpoint(java.lang.String)
//  .httpEndpoint(IResolvable)
//  .httpTokens(java.lang.String)
//  .httpTokens(IResolvable)
//  .imageFamily(java.lang.String)
//  .imageFamily(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .instanceChargeType(java.lang.String)
//  .instanceChargeType(IResolvable)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .internetMaxBandwidthOut(java.lang.Number)
//  .internetMaxBandwidthOut(IResolvable)
//  .ioOptimized(java.lang.String)
//  .ioOptimized(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .passwordInherit(java.lang.Boolean)
//  .passwordInherit(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .privatePoolOptions(IResolvable)
//  .privatePoolOptions(PrivatePoolOptionsProperty)
//  .ramRoleName(java.lang.String)
//  .ramRoleName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityEnhancementStrategy(java.lang.String)
//  .securityEnhancementStrategy(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityGroupIds(IResolvable)
//  .securityGroupIds(java.util.List<java.lang.String)
//  .securityGroupIds(IResolvable>)
//  .spotDuration(java.lang.Number)
//  .spotDuration(IResolvable)
//  .spotInterruptionBehavior(java.lang.String)
//  .spotInterruptionBehavior(IResolvable)
//  .spotPriceLimit(java.lang.String)
//  .spotPriceLimit(IResolvable)
//  .spotStrategy(java.lang.String)
//  .spotStrategy(IResolvable)
//  .storageSetId(java.lang.String)
//  .storageSetId(IResolvable)
//  .storageSetPartitionNumber(java.lang.Number)
//  .storageSetPartitionNumber(IResolvable)
//  .subscriptionDeletionForce(java.lang.Boolean)
//  .subscriptionDeletionForce(IResolvable)
//  .systemDiskCategory(java.lang.String)
//  .systemDiskCategory(IResolvable)
//  .systemDiskDescription(java.lang.String)
//  .systemDiskDescription(IResolvable)
//  .systemDiskDiskName(java.lang.String)
//  .systemDiskDiskName(IResolvable)
//  .systemDiskPerformanceLevel(java.lang.String)
//  .systemDiskPerformanceLevel(IResolvable)
//  .systemDiskSize(java.lang.Number)
//  .systemDiskSize(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tenancy(java.lang.String)
//  .tenancy(IResolvable)
//  .useAdditionalService(java.lang.Boolean)
//  .useAdditionalService(IResolvable)
//  .userData(java.lang.String)
//  .userData(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
//  .zoneIds(IResolvable)
//  .zoneIds(java.util.List<java.lang.String)
//  .zoneIds(IResolvable>)
    .build();

Properties

instanceType^Required

public java.lang.Object getInstanceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: Ecs instance supported instance type, make sure it should be correct.

affinity^Optional

public java.lang.Object getAffinity();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.

Valid values:

• default: does not associate the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
• host: associates the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot start. Default value: default.

allocatePublicIp^Optional

public java.lang.Object getAllocatePublicIp();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.

If property InternetMaxBandwidthOut set to 0, it will not assign public ip.

autoRenew^Optional

public java.lang.Object getAutoRenew();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Whether renew the fee automatically?

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal.False: no automatic renewal. Default value is False.

autoRenewPeriod^Optional

public java.lang.Object getAutoRenewPeriod();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenewPeriod: The time period of auto renew.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.

creditSpecification^Optional

public java.lang.Object getCreditSpecification();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

• Standard: the standard mode.
• Unlimited: the unlimited mode.

dedicatedHostId^Optional

public java.lang.Object getDedicatedHostId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostId: The ID of the dedicated host.

You can call the DescribeDedicatedHosts operation to query the list of dedicated host IDs.

Spot instances cannot be created on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are automatically ignored.

deletionProtection^Optional

public java.lang.Object getDeletionProtection();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.

deploymentSetGroupNo^Optional

public java.lang.Object getDeploymentSetGroupNo();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.

If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. Valid values: 1 to 7.

deploymentSetId^Optional

public java.lang.Object getDeploymentSetId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property deploymentSetId: Deployment set ID.

description^Optional

public java.lang.Object getDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Description of the instance, [2, 256] characters.

Do not fill or empty, the default is empty.

diskMappings^Optional

public java.lang.Object getDiskMappings();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDiskMappingsProperty>

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks. If the image contains a data disk, you can specify other parameters of the data disk via the same value of parameter "Device". If parameter "Category" is not specified, it will be cloud_efficiency instead of "Category" of data disk in the image.

hostName^Optional

public java.lang.Object getHostName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property hostName: Host name of created ecs instance.

at least 2 characters, and '.' '-' Is not the first and last characters as hostname, not continuous use. Windows platform can be up to 15 characters, allowing letters (without limiting case), numbers and '-', and does not support the number of points, not all is digital ('.').Other (Linux, etc.) platform up to 64 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components.

hpcClusterId^Optional

public java.lang.Object getHpcClusterId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property hpcClusterId: The ID of the high performance computing (HPC) cluster to which the instance belongs.

This parameter is required when you create instances of a Supper Computing Cluster (SCC) instance type. For information about how to create an HPC cluster, see CreateHpcCluster.

httpEndpoint^Optional

public java.lang.Object getHttpEndpoint();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.

Valid values:

• enabled
• disabled Default value: enabled.

httpTokens^Optional

public java.lang.Object getHttpTokens();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.

Valid values:

• optional: does not forcefully use the security-enhanced mode (IMDSv2).
• required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode. Default value: optional.

imageFamily^Optional

public java.lang.Object getImageFamily();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageFamily: The name of the image family.

You can set this parameter to obtain the latest available custom image from the specified image family to create the instance.

• ImageFamily must be empty if ImageId is specified.
• ImageFamily can be specified if ImageId is not specified.

imageId^Optional

public java.lang.Object getImageId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: The image ID.

public java.lang.Object getInstanceChargeType();

public java.lang.Object getInstanceName();

public java.lang.Object getInternetChargeType();

public java.lang.Object getInternetMaxBandwidthOut();

public java.lang.Object getIoOptimized();

public java.lang.Object getKeyPairName();

public java.lang.Object getPassword();

public java.lang.Object getPasswordInherit();

public java.lang.Object getPeriod();

public java.lang.Object getPeriodUnit();

public java.lang.Object getPrivateIpAddress();

public java.lang.Object getPrivatePoolOptions();

public java.lang.Object getRamRoleName();

public java.lang.Object getResourceGroupId();

public java.lang.Object getSecurityEnhancementStrategy();

public java.lang.Object getSecurityGroupId();

public java.lang.Object getSecurityGroupIds();

public java.lang.Object getSpotDuration();

public java.lang.Object getSpotInterruptionBehavior();

public java.lang.Object getSpotPriceLimit();

public java.lang.Object getSpotStrategy();

public java.lang.Object getStorageSetId();

public java.lang.Object getStorageSetPartitionNumber();

public java.lang.Object getSubscriptionDeletionForce();

public java.lang.Object getSystemDiskCategory();

public java.lang.Object getSystemDiskDescription();

public java.lang.Object getSystemDiskDiskName();

public java.lang.Object getSystemDiskPerformanceLevel();

public java.lang.Object getSystemDiskSize();

public java.util.List<TagsProperty> getTags();

public java.lang.Object getTenancy();

public java.lang.Object getUseAdditionalService();

public java.lang.Object getUserData();

public java.lang.Object getVpcId();

public java.lang.Object getVSwitchId();

public java.lang.Object getZoneId();

public java.lang.Object getZoneIds();