pulumi-alicloud-kotlin/com.pulumi.alicloud.ecs.kotlin/EcsInstanceSetArgs

EcsInstanceSetArgs

data class EcsInstanceSetArgs(val amount: Output<Int>? = null, val autoReleaseTime: Output<String>? = null, val autoRenew: Output<Boolean>? = null, val autoRenewPeriod: Output<Int>? = null, val bootCheckOsWithAssistant: Output<Boolean>? = null, val dataDisks: Output<List<EcsInstanceSetDataDiskArgs>>? = null, val dedicatedHostId: Output<String>? = null, val deletionProtection: Output<Boolean>? = null, val deploymentSetId: Output<String>? = null, val description: Output<String>? = null, val excludeInstanceFilter: Output<EcsInstanceSetExcludeInstanceFilterArgs>? = null, val hostName: Output<String>? = null, val hpcClusterId: Output<String>? = null, val imageId: Output<String>? = null, val instanceChargeType: Output<String>? = null, val instanceName: Output<String>? = null, val instanceType: Output<String>? = null, val internetChargeType: Output<String>? = null, val internetMaxBandwidthOut: Output<Int>? = null, val keyPairName: Output<String>? = null, val launchTemplateId: Output<String>? = null, val launchTemplateName: Output<String>? = null, val launchTemplateVersion: Output<String>? = null, val networkInterfaces: Output<List<EcsInstanceSetNetworkInterfaceArgs>>? = null, val password: Output<String>? = null, val passwordInherit: Output<Boolean>? = null, val period: Output<Int>? = null, val periodUnit: Output<String>? = null, val ramRoleName: Output<String>? = null, val resourceGroupId: Output<String>? = null, val securityEnhancementStrategy: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val spotPriceLimit: Output<Double>? = null, val spotStrategy: Output<String>? = null, val systemDiskAutoSnapshotPolicyId: Output<String>? = null, val systemDiskCategory: Output<String>? = null, val systemDiskDescription: Output<String>? = null, val systemDiskName: Output<String>? = null, val systemDiskPerformanceLevel: Output<String>? = null, val systemDiskSize: Output<Int>? = null, val tags: Output<Map<String, String>>? = null, val uniqueSuffix: Output<Boolean>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<EcsInstanceSetArgs>

Provides a ECS Instance Set resource. For information about ECS Instance Set and how to use it, see What is Instance Set.

NOTE: Available since v1.173.0. NOTE: This resource is used to batch create a group of instance resources with the same configuration. However, this resource is not recommended. alicloud.ecs.Instance is preferred. NOTE: In the instances managed by this resource, names are automatically generated based on instance_name and unique_suffix. NOTE: Only tags support batch modification.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.ecs.EcsInstanceSet;
import com.pulumi.alicloud.ecs.EcsInstanceSetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableDiskCategory("cloud_efficiency")
            .availableResourceCreation("VSwitch")
            .build());
        final var defaultInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .availabilityZone(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .cpuCoreCount(1)
            .memorySize(2)
            .build());
        final var defaultImages = EcsFunctions.getImages(GetImagesArgs.builder()
            .nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
            .mostRecent(true)
            .owners("system")
            .build());
        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.17.3.0/24")
            .build());
        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName(name)
            .cidrBlock("172.17.3.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .build());
        var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
            .vpcId(defaultNetwork.id())
            .build());
        var beijingK = new EcsInstanceSet("beijingK", EcsInstanceSetArgs.builder()
            .amount(10)
            .imageId(defaultImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
            .instanceType(defaultInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
            .instanceName(name)
            .instanceChargeType("PostPaid")
            .systemDiskPerformanceLevel("PL0")
            .systemDiskCategory("cloud_efficiency")
            .systemDiskSize(200)
            .vswitchId(defaultSwitch.id())
            .securityGroupIds(defaultSecurityGroup.stream().map(element -> element.id()).collect(toList()))
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .build());
    }
}

Constructors

EcsInstanceSetArgs

fun EcsInstanceSetArgs(amount: Output<Int>? = null, autoReleaseTime: Output<String>? = null, autoRenew: Output<Boolean>? = null, autoRenewPeriod: Output<Int>? = null, bootCheckOsWithAssistant: Output<Boolean>? = null, dataDisks: Output<List<EcsInstanceSetDataDiskArgs>>? = null, dedicatedHostId: Output<String>? = null, deletionProtection: Output<Boolean>? = null, deploymentSetId: Output<String>? = null, description: Output<String>? = null, excludeInstanceFilter: Output<EcsInstanceSetExcludeInstanceFilterArgs>? = null, hostName: Output<String>? = null, hpcClusterId: Output<String>? = null, imageId: Output<String>? = null, instanceChargeType: Output<String>? = null, instanceName: Output<String>? = null, instanceType: Output<String>? = null, internetChargeType: Output<String>? = null, internetMaxBandwidthOut: Output<Int>? = null, keyPairName: Output<String>? = null, launchTemplateId: Output<String>? = null, launchTemplateName: Output<String>? = null, launchTemplateVersion: Output<String>? = null, networkInterfaces: Output<List<EcsInstanceSetNetworkInterfaceArgs>>? = null, password: Output<String>? = null, passwordInherit: Output<Boolean>? = null, period: Output<Int>? = null, periodUnit: Output<String>? = null, ramRoleName: Output<String>? = null, resourceGroupId: Output<String>? = null, securityEnhancementStrategy: Output<String>? = null, securityGroupIds: Output<List<String>>? = null, spotPriceLimit: Output<Double>? = null, spotStrategy: Output<String>? = null, systemDiskAutoSnapshotPolicyId: Output<String>? = null, systemDiskCategory: Output<String>? = null, systemDiskDescription: Output<String>? = null, systemDiskName: Output<String>? = null, systemDiskPerformanceLevel: Output<String>? = null, systemDiskSize: Output<Int>? = null, tags: Output<Map<String, String>>? = null, uniqueSuffix: Output<Boolean>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null)

Functions

toJava

open override fun toJava(): EcsInstanceSetArgs

Properties

amount

val amount: Output<Int>? = null

The number of instances that you want to create. Valid values: 1 to 100.

autoReleaseTime

val autoReleaseTime: Output<String>? = null

The automatic release time of the PostPaid instance.

autoRenew

val autoRenew: Output<Boolean>? = null

Whether to enable auto-renewal for the instance. This parameter is valid only when the instance_charge_type is set to PrePaid.

autoRenewPeriod

val autoRenewPeriod: Output<Int>? = null

Auto renewal period of an instance, in the unit of month. It is valid when instance_charge_type is PrePaid.

bootCheckOsWithAssistant

val bootCheckOsWithAssistant: Output<Boolean>? = null

Indicate how to check instance ready to use.

dataDisks

val dataDisks: Output<List<EcsInstanceSetDataDiskArgs>>? = null

The list of data disks created with instance. See data_disks below..

dedicatedHostId

val dedicatedHostId: Output<String>? = null

The ID of the dedicated host on which to create the instance. If the dedicated_host_id is specified, the spot_strategy and spot_price_limit are ignored. This is because preemptible instances cannot be created on dedicated hosts.

deletionProtection

val deletionProtection: Output<Boolean>? = null

Whether to enable release protection for the instance.

deploymentSetId

val deploymentSetId: Output<String>? = null

The ID of the deployment set to which to deploy the instance.

description

val description: Output<String>? = null

The description of the instance, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://.

excludeInstanceFilter

val excludeInstanceFilter: Output<EcsInstanceSetExcludeInstanceFilterArgs>? = null

The instances that need to be excluded from the Instance Set. See exclude_instance_filter below.

hostName

val hostName: Output<String>? = null

The hostname of instance.

hpcClusterId

val hpcClusterId: Output<String>? = null

The ID of the Elastic High Performance Computing (E-HPC) cluster to which to assign the instance.

imageId

val imageId: Output<String>? = null

The Image to use for the instance.

instanceChargeType

val instanceChargeType: Output<String>? = null

The billing method of the instance. Valid values: PrePaid, PostPaid.

instanceName

val instanceName: Output<String>? = null

The name of the ECS. This instance_name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin with a hyphen, and must not begin with http:// or https://.

instanceType

val instanceType: Output<String>? = null

The type of instance to start.

internetChargeType

val internetChargeType: Output<String>? = null

The Internet charge type of the instance. Valid values are PayByBandwidth, PayByTraffic.

internetMaxBandwidthOut

val internetMaxBandwidthOut: Output<Int>? = null

The Maximum outgoing bandwidth to the public network, measured in Mbps (Mega bit per second). Valid values: 1 to 100.

keyPairName

val keyPairName: Output<String>? = null

The name of key pair that can login ECS instance successfully without password.

launchTemplateId

val launchTemplateId: Output<String>? = null

The ID of the launch template.

launchTemplateName

val launchTemplateName: Output<String>? = null

The name of the launch template. To use a launch template to create an instance, you must use the launch_template_id or launch_template_name parameter to specify the launch template.

launchTemplateVersion

val launchTemplateVersion: Output<String>? = null

The version of the launch template.

networkInterfaces

val networkInterfaces: Output<List<EcsInstanceSetNetworkInterfaceArgs>>? = null

A list of NetworkInterface. See network_interfaces below..

password

val password: Output<String>? = null

The password to an instance is a string of 8 to 30 characters. It must contain uppercase/lowercase letters and numerals, but cannot contain special symbols.

passwordInherit

val passwordInherit: Output<Boolean>? = null

Whether to use the password preset in the image.

period

val period: Output<Int>? = null

The duration that you will buy the resource, in month. It is valid when instance_charge_type is PrePaid.

periodUnit

val periodUnit: Output<String>? = null

The duration unit that you will buy the resource. It is valid when instance_charge_type is 'PrePaid'. Valid value: Week, Month.

ramRoleName

val ramRoleName: Output<String>? = null

The Instance RAM role name.

resourceGroupId

val resourceGroupId: Output<String>? = null

The ID of resource group which the instance belongs.

securityEnhancementStrategy

val securityEnhancementStrategy: Output<String>? = null

The security enhancement strategy.

securityGroupIds

val securityGroupIds: Output<List<String>>? = null

A list of security group ids to associate with.

spotPriceLimit

val spotPriceLimit: Output<Double>? = null

The hourly price threshold of a instance, and it takes effect only when parameter 'spot_strategy' is 'SpotWithPriceLimit'. Three decimals is allowed at most.

spotStrategy

val spotStrategy: Output<String>? = null

The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter instance_charge_type is 'PostPaid'.

systemDiskAutoSnapshotPolicyId

val systemDiskAutoSnapshotPolicyId: Output<String>? = null

The ID of the automatic snapshot policy applied to the system disk.

systemDiskCategory

val systemDiskCategory: Output<String>? = null

The category of the system disk. Valid values are cloud_efficiency, cloud_ssd, cloud_essd, cloud.

systemDiskDescription

val systemDiskDescription: Output<String>? = null

The description of the system disk. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

systemDiskName

val systemDiskName: Output<String>? = null

The name of the system disk.

systemDiskPerformanceLevel

val systemDiskPerformanceLevel: Output<String>? = null

The performance level of the ESSD used as the system disk. Valid values: PL0, PL1, PL2, PL3.

systemDiskSize

val systemDiskSize: Output<Int>? = null

The size of the system disk, measured in GiB. Value range: values: 20 to 500.