InstanceGroupProps

Properties for defining a InstanceGroup.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs"
&alicloudroscdkecs.InstanceGroupProps {
    InstanceType: interface{},
    MaxAmount: interface{},
    Affinity: interface{},
    AllocatePublicIp: interface{},
    AutoReleaseTime: interface{},
    AutoRenew: interface{},
    AutoRenewPeriod: interface{},
    CpuOptions: interface{},
    CreditSpecification: interface{},
    DedicatedHostId: interface{},
    DeletionForce: interface{},
    DeletionProtection: interface{},
    DeploymentSetGroupNo: interface{},
    DeploymentSetId: interface{},
    Description: interface{},
    DiskMappings: interface{},
    EniMappings: interface{},
    HostName: interface{},
    HostNames: interface{},
    HpcClusterId: interface{},
    HttpEndpoint: interface{},
    HttpTokens: interface{},
    ImageFamily: interface{},
    ImageId: interface{},
    ImageOptions: interface{},
    InstanceChargeType: interface{},
    InstanceName: interface{},
    InternetChargeType: interface{},
    InternetMaxBandwidthOut: interface{},
    IoOptimized: interface{},
    Ipv6AddressCount: interface{},
    Ipv6Addresses: interface{},
    KeyPairName: interface{},
    LaunchTemplateId: interface{},
    LaunchTemplateName: interface{},
    LaunchTemplateVersion: interface{},
    NetworkInterfaceQueueNumber: interface{},
    NetworkOptions: interface{},
    NetworkType: interface{},
    Password: interface{},
    PasswordInherit: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    PrivateIpAddress: interface{},
    PrivatePoolOptions: interface{},
    RamRoleName: interface{},
    ResourceGroupId: interface{},
    SchedulerOptions: interface{},
    SecurityEnhancementStrategy: interface{},
    SecurityGroupId: interface{},
    SecurityGroupIds: interface{},
    SecurityOptions: interface{},
    SpotDuration: interface{},
    SpotInterruptionBehavior: interface{},
    SpotPriceLimit: interface{},
    SpotStrategy: interface{},
    StorageSetId: interface{},
    StorageSetPartitionNumber: interface{},
    SubscriptionDeletionForce: interface{},
    SystemDiskAutoSnapshotPolicyId: interface{},
    SystemDiskBurstingEnabled: interface{},
    SystemDiskCategory: interface{},
    SystemDiskDescription: interface{},
    SystemDiskDiskName: interface{},
    SystemDiskEncryptAlgorithm: interface{},
    SystemDiskEncrypted: interface{},
    SystemDiskKmsKeyId: interface{},
    SystemDiskPerformanceLevel: interface{},
    SystemDiskProvisionedIops: interface{},
    SystemDiskSize: interface{},
    SystemDiskStorageClusterId: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkecs.RosInstanceGroup.TagsProperty,
    Tenancy: interface{},
    UniqueSuffix: interface{},
    UpdatePolicy: interface{},
    UseAdditionalService: interface{},
    UserData: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
    ZoneIds: interface{},
}

Properties

InstanceType^Required

InstanceType interface{}

• Type: interface{}

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

MaxAmount^Required

MaxAmount interface{}

• Type: interface{}

Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.

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.

AutoReleaseTime^Optional

AutoReleaseTime interface{}

• Type: interface{}

Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.

format is 'yyyy-MM-ddTHH:mm:ssZ'. Not bigger than 3 years from this day onwards

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.Old instances will not be changed.

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.Old instances will not be changed.

CpuOptions^Optional

CpuOptions interface{}

• Type: interface{}

Property cpuOptions: Cpu options.

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: 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.

DeletionForce^Optional

DeletionForce interface{}

• Type: interface{}

Property deletionForce: Whether force delete the instance.

Default value is false.

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.

The change of the property does not affect existing instances.

Description^Optional

Description interface{}

• Type: interface{}

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

Do not fill or empty, the default is empty. Old instances will not be changed.

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.Old instances will not be changed.

EniMappings^Optional

EniMappings interface{}

• Type: interface{}

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.

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. Support to use the regular expression to set the different instance name for each ECS instance. HostName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'host[123,4]tail'. If you creates 3 instances with hostname 'host[123,4]tail', all the host names of instances are host0123tail, host0124tail, host0125tail. The 'name_prefix[begin_number,bits]name_suffix' should follow those rules:

1. 'name_prefix' is required.
2. 'name_suffix' is optional.
3. The name regular expression can't include any spaces.
4. The 'bits' must be in range [1, 6].
5. The 'begin_number' must be in range [0, 999999].
6. You could only specify 'begin_number'. The 'bits' will be set as 6 by default.
7. You also could only specify the [] or [,]. The 'begin_number' will be set as 0 by default, the 'bits' will be set as 6 by default.
8. If the bits of 'begin_number' is less than the 'bits' you specified, like [1234,1], the 'bits' will be set as 6 by default. The host name is specified by regular expression works after restart instance manually.

HostNames^Optional

HostNames interface{}

• Type: interface{}

Property hostNames: The hostname of instance N.

You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:

• The maximum value of N must be the same as the Amount value. For example, if you set Amount to 2, you can use HostNames.1 and HostNames.2 to specify hostnames for the individual instances. Examples: HostNames.1=test1 and HostNames.2=test2.
• You cannot specify both HostName and HostNames.N.
• The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).
• For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).
• For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

HpcClusterId^Optional

HpcClusterId interface{}

• Type: interface{}

Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.

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: The image ID.

ImageOptions interface{}

InstanceChargeType interface{}

InstanceName interface{}

InternetChargeType interface{}

InternetMaxBandwidthOut interface{}

IoOptimized interface{}

Ipv6AddressCount interface{}

Ipv6Addresses interface{}

KeyPairName interface{}

LaunchTemplateId interface{}

LaunchTemplateName interface{}

LaunchTemplateVersion interface{}

NetworkInterfaceQueueNumber interface{}

NetworkOptions interface{}

NetworkType interface{}

Password interface{}

PasswordInherit interface{}

Period interface{}

PeriodUnit interface{}

PrivateIpAddress interface{}

PrivatePoolOptions interface{}

RamRoleName interface{}

ResourceGroupId interface{}

SchedulerOptions interface{}

SecurityEnhancementStrategy interface{}

SecurityGroupId interface{}

SecurityGroupIds interface{}

SecurityOptions interface{}

SpotDuration interface{}

SpotInterruptionBehavior interface{}

SpotPriceLimit interface{}

SpotStrategy interface{}

StorageSetId interface{}

StorageSetPartitionNumber interface{}

SubscriptionDeletionForce interface{}

SystemDiskAutoSnapshotPolicyId interface{}

SystemDiskBurstingEnabled interface{}

SystemDiskCategory interface{}

SystemDiskDescription interface{}

SystemDiskDiskName interface{}

SystemDiskEncryptAlgorithm interface{}

SystemDiskEncrypted interface{}

SystemDiskKmsKeyId interface{}

SystemDiskPerformanceLevel interface{}

SystemDiskProvisionedIops interface{}

SystemDiskSize interface{}

SystemDiskStorageClusterId interface{}

Tags *[]TagsProperty

Tenancy interface{}

UniqueSuffix interface{}

UpdatePolicy interface{}

UseAdditionalService interface{}

UserData interface{}

VpcId interface{}

VSwitchId interface{}

ZoneId interface{}

ZoneIds interface{}