InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs"
&alicloudroscdkecs.InstanceProps {
    InstanceType: interface{},
    Affinity: interface{},
    AllocatePublicIp: interface{},
    AutoRenew: interface{},
    AutoRenewPeriod: interface{},
    CreditSpecification: interface{},
    DedicatedHostId: interface{},
    DeletionProtection: interface{},
    DeploymentSetGroupNo: interface{},
    DeploymentSetId: interface{},
    Description: interface{},
    DiskMappings: interface{},
    HostName: interface{},
    HpcClusterId: interface{},
    HttpEndpoint: interface{},
    HttpTokens: interface{},
    ImageFamily: interface{},
    ImageId: interface{},
    InstanceChargeType: interface{},
    InstanceName: interface{},
    InternetChargeType: interface{},
    InternetMaxBandwidthOut: interface{},
    IoOptimized: interface{},
    KeyPairName: interface{},
    Password: interface{},
    PasswordInherit: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    PrivatePoolOptions: interface{},
    RamRoleName: interface{},
    ResourceGroupId: interface{},
    SecurityEnhancementStrategy: interface{},
    SecurityGroupId: interface{},
    SecurityGroupIds: interface{},
    SpotDuration: interface{},
    SpotInterruptionBehavior: interface{},
    SpotPriceLimit: interface{},
    SpotStrategy: interface{},
    StorageSetId: interface{},
    StorageSetPartitionNumber: interface{},
    SystemDiskCategory: interface{},
    SystemDiskDescription: interface{},
    SystemDiskDiskName: interface{},
    SystemDiskPerformanceLevel: interface{},
    SystemDiskSize: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs.RosInstance.TagsProperty,
    Tenancy: interface{},
    UseAdditionalService: interface{},
    UserData: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    ZoneIds: interface{},
}

Properties

Name	Type	Description
InstanceType	interface{}	Property instanceType: Ecs instance supported instance type, make sure it should be correct.
Affinity	interface{}	Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.
AllocatePublicIp	interface{}	Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.
AutoRenew	interface{}	Property autoRenew: Whether renew the fee automatically?
AutoRenewPeriod	interface{}	Property autoRenewPeriod: The time period of auto renew.
CreditSpecification	interface{}	Property creditSpecification: The performance mode of the burstable instance.
DedicatedHostId	interface{}	Property dedicatedHostId: which dedicated host will be deployed.
DeletionProtection	interface{}	Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
DeploymentSetGroupNo	interface{}	Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.
DeploymentSetId	interface{}	Property deploymentSetId: Deployment set ID.
Description	interface{}	Property description: Description of the instance, [2, 256] characters.
DiskMappings	interface{}	Property diskMappings: Disk mappings to attach to instance.
HostName	interface{}	Property hostName: Host name of created ecs instance.
HpcClusterId	interface{}	Property hpcClusterId: The HPC cluster ID to which the instance belongs.
HttpEndpoint	interface{}	Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.
HttpTokens	interface{}	Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.
ImageFamily	interface{}	Property imageFamily: The name of the image family.
ImageId	interface{}	Property imageId: Image ID to create ecs instance.
InstanceChargeType	interface{}	Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.
InstanceName	interface{}	Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
InternetChargeType	interface{}	Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.
InternetMaxBandwidthOut	interface{}	Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
IoOptimized	interface{}	Property ioOptimized: The 'optimized' instance can provide better IO performance.
KeyPairName	interface{}	Property keyPairName: SSH key pair name.
Password	interface{}	Property password: Password of created ecs instance.
PasswordInherit	interface{}	Property passwordInherit: Specifies whether to use the password preset in the image.
Period	interface{}	Property period: Prepaid time period.
PeriodUnit	interface{}	Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.
PrivateIpAddress	interface{}	Property privateIpAddress: Private IP for the instance created.
PrivatePoolOptions	interface{}	Property privatePoolOptions: The options of the private pool.
RamRoleName	interface{}	Property ramRoleName: Instance RAM role name.
ResourceGroupId	interface{}	Property resourceGroupId: Resource group id.
SecurityEnhancementStrategy	interface{}	Property securityEnhancementStrategy:.
SecurityGroupId	interface{}	Property securityGroupId: Security group to create ecs instance.
SecurityGroupIds	interface{}	Property securityGroupIds: The ID list of security group to which to assign the instance.
SpotDuration	interface{}	Property spotDuration: The protection period of the preemptible instance.
SpotInterruptionBehavior	interface{}	Property spotInterruptionBehavior: The interruption mode of the preemptible instance.
SpotPriceLimit	interface{}	Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
SpotStrategy	interface{}	Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
StorageSetId	interface{}	Property storageSetId: The storage set ID.
StorageSetPartitionNumber	interface{}	Property storageSetPartitionNumber: The maximum number of partitions in the storage set.
SystemDiskCategory	interface{}	Property systemDiskCategory: Category of system disk.
SystemDiskDescription	interface{}	Property systemDiskDescription: Description of created system disk.
SystemDiskDiskName	interface{}	Property systemDiskDiskName: Name of created system disk.
SystemDiskPerformanceLevel	interface{}	Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.
SystemDiskSize	interface{}	Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.
Tags	*[]TagsProperty	Property tags: Tags to attach to instance.
Tenancy	interface{}	Property tenancy: Specifies whether to create the instance on a dedicated host.
UseAdditionalService	interface{}	Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.
UserData	interface{}	Property userData: User data to pass to instance.
VpcId	interface{}	Property vpcId: The VPC id to create ecs instance.
VSwitchId	interface{}	Property vSwitchId: The vSwitch Id to create ecs instance.
ZoneId	interface{}	Property zoneId: The ID of the zone to which the instance belongs.
ZoneIds	interface{}	Property zoneIds: Zone ids for query parameters.

---

InstanceType^Required

InstanceType interface{}

• Type: interface{}

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

---

Affinity^Optional

Affinity interface{}

• Type: interface{}

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

AllocatePublicIp interface{}

• Type: interface{}

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

AutoRenew interface{}

• Type: interface{}

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

AutoRenewPeriod interface{}

• Type: interface{}

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

CreditSpecification interface{}

• Type: interface{}

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

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

---

DedicatedHostId^Optional

DedicatedHostId interface{}

• Type: interface{}

Property dedicatedHostId: which dedicated host will be deployed.

---

DeletionProtection^Optional

DeletionProtection interface{}

• Type: interface{}

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

---

DeploymentSetGroupNo^Optional

DeploymentSetGroupNo interface{}

• Type: interface{}

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

DeploymentSetId interface{}

• Type: interface{}

Property deploymentSetId: Deployment set ID.

---

Description^Optional

Description interface{}

• Type: interface{}

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

Do not fill or empty, the default is empty.

---

DiskMappings^Optional

DiskMappings interface{}

• Type: interface{}

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

HostName interface{}

• Type: interface{}

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

HpcClusterId interface{}

• Type: interface{}

Property hpcClusterId: The HPC cluster ID to which the instance belongs.

---

HttpEndpoint^Optional

HttpEndpoint interface{}

• Type: interface{}

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

Valid values:

• enabled
• disabled Default value: enabled.

---

HttpTokens^Optional

HttpTokens interface{}

• Type: interface{}

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

ImageFamily interface{}

• Type: interface{}

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

ImageId interface{}

• Type: interface{}

Property imageId: Image ID to create ecs instance.

---

InstanceChargeType^Optional

InstanceChargeType interface{}

• Type: interface{}

Property instanceChargeType: Instance Charge type, allowed value: Prepaid and Postpaid.

If specified Prepaid, please ensure you have sufficient balance in your account. Or instance creation will be failure. Default value is Postpaid.

---

InstanceName^Optional

InstanceName interface{}

• Type: interface{}

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

---

InternetChargeType^Optional

InternetChargeType interface{}

• Type: interface{}

Property internetChargeType: Instance internet access charge type.Support 'PayByBandwidth' and 'PayByTraffic' only. Default is PayByTraffic.

---

InternetMaxBandwidthOut^Optional

InternetMaxBandwidthOut interface{}

• Type: interface{}

Property internetMaxBandwidthOut: Set internet output bandwidth of instance.

Unit is Mbps(Mega bit per second). Range is [0,200]. Default is 1.While the property is not 0, public ip will be assigned for instance.

---

IoOptimized^Optional

IoOptimized interface{}

• Type: interface{}

Property ioOptimized: The 'optimized' instance can provide better IO performance.

Support 'none' and 'optimized' only, default is 'optimized'.

---

KeyPairName^Optional

KeyPairName interface{}

• Type: interface{}

Property keyPairName: SSH key pair name.

---

Password^Optional

Password interface{}

• Type: interface{}

Property password: Password of created ecs instance.

Must contain at least 3 types of special character, lower character, upper character, number.

---

PasswordInherit^Optional

PasswordInherit interface{}

• Type: interface{}

Property passwordInherit: Specifies whether to use the password preset in the image.

To use the PasswordInherit parameter, the Password parameter must be empty and you must make sure that the selected image has a password configured.

---

Period^Optional

Period interface{}

• Type: interface{}

Property period: Prepaid time period.

Unit is month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Default value is 1.

---

PeriodUnit^Optional

PeriodUnit interface{}

• Type: interface{}

Property periodUnit: Unit of prepaid time period, it could be Week\/Month\/Year.

Default value is Month.

---

PrivateIpAddress^Optional

PrivateIpAddress interface{}

• Type: interface{}

Property privateIpAddress: Private IP for the instance created.

Only works for VPC instance and cannot duplicated with existing instance.

---

PrivatePoolOptions^Optional

PrivatePoolOptions interface{}

• Type: interface{}

Property privatePoolOptions: The options of the private pool.

---

RamRoleName^Optional

RamRoleName interface{}

• Type: interface{}

Property ramRoleName: Instance RAM role name.

The name is provided and maintained by Resource Access Management (RAM) and can be queried using ListRoles. For more information, see RAM API CreateRole and ListRoles.

---

ResourceGroupId^Optional

ResourceGroupId interface{}

• Type: interface{}

Property resourceGroupId: Resource group id.

---

SecurityEnhancementStrategy^Optional

SecurityEnhancementStrategy interface{}

• Type: interface{}

Property securityEnhancementStrategy:.

---

SecurityGroupId^Optional

SecurityGroupId interface{}

• Type: interface{}

Property securityGroupId: Security group to create ecs instance.

For classic instance need the security group not belong to VPC, for VPC instance, please make sure the security group belong to specified VPC.

---

SecurityGroupIds^Optional

SecurityGroupIds interface{}

• Type: interface{}

Property securityGroupIds: The ID list of security group to which to assign the instance.

The max length is based on the maximum number of security groups to which an instance can belong. For more information, see the "Security group limits" section in Limits.

---

SpotDuration^Optional

SpotDuration interface{}

• Type: interface{}

Property spotDuration: The protection period of the preemptible instance.

Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6. Protection periods of 2, 3, 4, 5, and 6 hours are in invitational preview. If you want to set this parameter to one of these values, submit a ticket. If this parameter is set to 0, no protection period is configured for the preemptible instance. Default value: 1.

---

SpotInterruptionBehavior^Optional

SpotInterruptionBehavior interface{}

• Type: interface{}

Property spotInterruptionBehavior: The interruption mode of the preemptible instance.

Default value: Terminate. Set the value to Terminate, which specifies to release the instance.

---

SpotPriceLimit^Optional

SpotPriceLimit interface{}

• Type: interface{}

Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Three decimals is allowed at most.

---

SpotStrategy^Optional

SpotStrategy interface{}

• Type: interface{}

Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Value range: "NoSpot: A regular Pay-As-You-Go instance", "SpotWithPriceLimit: A price threshold for a spot instance, ""SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance. "Default value: NoSpot.

---

StorageSetId^Optional

StorageSetId interface{}

• Type: interface{}

Property storageSetId: The storage set ID.

---

StorageSetPartitionNumber^Optional

StorageSetPartitionNumber interface{}

• Type: interface{}

Property storageSetPartitionNumber: The maximum number of partitions in the storage set.

The value must be greater than or equal to 2.

---

SystemDiskCategory^Optional

SystemDiskCategory interface{}

• Type: interface{}

Property systemDiskCategory: Category of system disk.

Default is cloud_efficiency. support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd|cloud_auto|cloud_essd_entry

---

SystemDiskDescription^Optional

SystemDiskDescription interface{}

• Type: interface{}

Property systemDiskDescription: Description of created system disk.

---

SystemDiskDiskName^Optional

SystemDiskDiskName interface{}

• Type: interface{}

Property systemDiskDiskName: Name of created system disk.

---

SystemDiskPerformanceLevel^Optional

SystemDiskPerformanceLevel interface{}

• Type: interface{}

Property systemDiskPerformanceLevel: The performance level of the enhanced SSD used as the system disk.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.

---

SystemDiskSize^Optional

SystemDiskSize interface{}

• Type: interface{}

Property systemDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

---

Tags^Optional

Tags *[]TagsProperty

• Type: *[]TagsProperty

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

---

Tenancy^Optional

Tenancy interface{}

• Type: interface{}

Property tenancy: Specifies whether to create the instance on a dedicated host.

Valid values:

• default: creates the instance on a non-dedicated host.
• host: creates the instance on a dedicated host. If you do not specify DedicatedHostId, Alibaba Cloud selects a dedicated host for the instance. Default value: default.

---

UseAdditionalService^Optional

UseAdditionalService interface{}

• Type: interface{}

Property useAdditionalService: Specifies whether to use the system configurations for virtual machines provided by Alibaba Cloud.

System configurations for Windows: NTP and KMS. System configurations for Linux: NTP and YUM.

---

UserData^Optional

UserData interface{}

• Type: interface{}

Property userData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

---

VpcId^Optional

VpcId interface{}

• Type: interface{}

Property vpcId: The VPC id to create ecs instance.

---

VSwitchId^Optional

VSwitchId interface{}

• Type: interface{}

Property vSwitchId: The vSwitch Id to create ecs instance.

---

ZoneId^Optional

ZoneId interface{}

• Type: interface{}

Property zoneId: The ID of the zone to which the instance belongs.

For more information, call the DescribeZones operation to query the most recent zone list. Default value is empty, which means random selection.

---

ZoneIds^Optional

ZoneIds interface{}

• Type: interface{}

Property zoneIds: Zone ids for query parameters.

---