aws-cdk-lib.aws_ec2.CfnInstance

CfnInstance L1 construct

Specifies an EC2 instance.

If an Elastic IP address is attached to your instance, AWS CloudFormation reattaches the Elastic IP address after it updates the instance. For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Construct›CfnElement›CfnRefElement›CfnResource›CfnInstance

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IInstanceRef,
• IConstruct,
• 1 more

  • IDependable

CloudFormation

AWS::EC2::Instance

Source

Generated code

Type last changed

v2.252.0 · 30 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnInstance = new ec2.CfnInstance(this, 'MyCfnInstance', /* all optional props */ {
  additionalInfo: 'additionalInfo',
  affinity: 'affinity',
  availabilityZone: 'availabilityZone',
  blockDeviceMappings: [{
    deviceName: 'deviceName',

    // the properties below are optional
    ebs: {
      deleteOnTermination: false,
      encrypted: false,
      iops: 123,
      kmsKeyId: 'kmsKeyId',
      snapshotId: 'snapshotId',
      volumeSize: 123,
      volumeType: 'volumeType',
    },
    noDevice: { },
    virtualName: 'virtualName',
  }],
  cpuOptions: {
    coreCount: 123,
    threadsPerCore: 123,
  },
  creditSpecification: {
    cpuCredits: 'cpuCredits',
  },
  disableApiTermination: false,
  ebsOptimized: false,
  elasticGpuSpecifications: [{
    type: 'type',
  }],
  elasticInferenceAccelerators: [{
    type: 'type',

    // the properties below are optional
    count: 123,
  }],
  enclaveOptions: {
    enabled: false,
  },
  hibernationOptions: {
    configured: false,
  },
  hostId: 'hostId',
  hostResourceGroupArn: 'hostResourceGroupArn',
  iamInstanceProfile: 'iamInstanceProfile',
  imageId: 'imageId',
  instanceInitiatedShutdownBehavior: 'instanceInitiatedShutdownBehavior',
  instanceType: 'instanceType',
  ipv6AddressCount: 123,
  ipv6Addresses: [{
    ipv6Address: 'ipv6Address',
  }],
  kernelId: 'kernelId',
  keyName: 'keyName',
  launchTemplate: {
    version: 'version',

    // the properties below are optional
    launchTemplateId: 'launchTemplateId',
    launchTemplateName: 'launchTemplateName',
  },
  licenseSpecifications: [{
    licenseConfigurationArn: 'licenseConfigurationArn',
  }],
  metadataOptions: {
    httpEndpoint: 'httpEndpoint',
    httpProtocolIpv6: 'httpProtocolIpv6',
    httpPutResponseHopLimit: 123,
    httpTokens: 'httpTokens',
    instanceMetadataTags: 'instanceMetadataTags',
  },
  monitoring: false,
  networkInterfaces: [{
    deviceIndex: 'deviceIndex',

    // the properties below are optional
    associateCarrierIpAddress: false,
    associatePublicIpAddress: false,
    deleteOnTermination: false,
    description: 'description',
    enaSrdSpecification: {
      enaSrdEnabled: false,
      enaSrdUdpSpecification: {
        enaSrdUdpEnabled: false,
      },
    },
    groupSet: ['groupSet'],
    ipv6AddressCount: 123,
    ipv6Addresses: [{
      ipv6Address: 'ipv6Address',
    }],
    networkInterfaceId: 'networkInterfaceId',
    privateIpAddress: 'privateIpAddress',
    privateIpAddresses: [{
      primary: false,
      privateIpAddress: 'privateIpAddress',
    }],
    secondaryPrivateIpAddressCount: 123,
    subnetId: 'subnetId',
  }],
  placementGroupName: 'placementGroupName',
  privateDnsNameOptions: {
    enableResourceNameDnsAaaaRecord: false,
    enableResourceNameDnsARecord: false,
    hostnameType: 'hostnameType',
  },
  privateIpAddress: 'privateIpAddress',
  propagateTagsToVolumeOnCreation: false,
  ramdiskId: 'ramdiskId',
  securityGroupIds: ['securityGroupIds'],
  securityGroups: ['securityGroups'],
  sourceDestCheck: false,
  ssmAssociations: [{
    documentName: 'documentName',

    // the properties below are optional
    associationParameters: [{
      key: 'key',
      value: ['value'],
    }],
  }],
  subnetId: 'subnetId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tenancy: 'tenancy',
  userData: 'userData',
  volumes: [{
    device: 'device',
    volumeId: 'volumeId',
  }],
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_instance = ec2.CfnInstance(self, "MyCfnInstance",
    additional_info="additionalInfo",
    affinity="affinity",
    availability_zone="availabilityZone",
    block_device_mappings=[ec2.CfnInstance.BlockDeviceMappingProperty(
        device_name="deviceName",

        # the properties below are optional
        ebs=ec2.CfnInstance.EbsProperty(
            delete_on_termination=False,
            encrypted=False,
            iops=123,
            kms_key_id="kmsKeyId",
            snapshot_id="snapshotId",
            volume_size=123,
            volume_type="volumeType"
        ),
        no_device=ec2.CfnInstance.NoDeviceProperty(),
        virtual_name="virtualName"
    )],
    cpu_options=ec2.CfnInstance.CpuOptionsProperty(
        core_count=123,
        threads_per_core=123
    ),
    credit_specification=ec2.CfnInstance.CreditSpecificationProperty(
        cpu_credits="cpuCredits"
    ),
    disable_api_termination=False,
    ebs_optimized=False,
    elastic_gpu_specifications=[ec2.CfnInstance.ElasticGpuSpecificationProperty(
        type="type"
    )],
    elastic_inference_accelerators=[ec2.CfnInstance.ElasticInferenceAcceleratorProperty(
        type="type",

        # the properties below are optional
        count=123
    )],
    enclave_options=ec2.CfnInstance.EnclaveOptionsProperty(
        enabled=False
    ),
    hibernation_options=ec2.CfnInstance.HibernationOptionsProperty(
        configured=False
    ),
    host_id="hostId",
    host_resource_group_arn="hostResourceGroupArn",
    iam_instance_profile="iamInstanceProfile",
    image_id="imageId",
    instance_initiated_shutdown_behavior="instanceInitiatedShutdownBehavior",
    instance_type="instanceType",
    ipv6_address_count=123,
    ipv6_addresses=[ec2.CfnInstance.InstanceIpv6AddressProperty(
        ipv6_address="ipv6Address"
    )],
    kernel_id="kernelId",
    key_name="keyName",
    launch_template=ec2.CfnInstance.LaunchTemplateSpecificationProperty(
        version="version",

        # the properties below are optional
        launch_template_id="launchTemplateId",
        launch_template_name="launchTemplateName"
    ),
    license_specifications=[ec2.CfnInstance.LicenseSpecificationProperty(
        license_configuration_arn="licenseConfigurationArn"
    )],
    metadata_options=ec2.CfnInstance.MetadataOptionsProperty(
        http_endpoint="httpEndpoint",
        http_protocol_ipv6="httpProtocolIpv6",
        http_put_response_hop_limit=123,
        http_tokens="httpTokens",
        instance_metadata_tags="instanceMetadataTags"
    ),
    monitoring=False,
    network_interfaces=[ec2.CfnInstance.NetworkInterfaceProperty(
        device_index="deviceIndex",

        # the properties below are optional
        associate_carrier_ip_address=False,
        associate_public_ip_address=False,
        delete_on_termination=False,
        description="description",
        ena_srd_specification=ec2.CfnInstance.EnaSrdSpecificationProperty(
            ena_srd_enabled=False,
            ena_srd_udp_specification=ec2.CfnInstance.EnaSrdUdpSpecificationProperty(
                ena_srd_udp_enabled=False
            )
        ),
        group_set=["groupSet"],
        ipv6_address_count=123,
        ipv6_addresses=[ec2.CfnInstance.InstanceIpv6AddressProperty(
            ipv6_address="ipv6Address"
        )],
        network_interface_id="networkInterfaceId",
        private_ip_address="privateIpAddress",
        private_ip_addresses=[ec2.CfnInstance.PrivateIpAddressSpecificationProperty(
            primary=False,
            private_ip_address="privateIpAddress"
        )],
        secondary_private_ip_address_count=123,
        subnet_id="subnetId"
    )],
    placement_group_name="placementGroupName",
    private_dns_name_options=ec2.CfnInstance.PrivateDnsNameOptionsProperty(
        enable_resource_name_dns_aaaa_record=False,
        enable_resource_name_dns_a_record=False,
        hostname_type="hostnameType"
    ),
    private_ip_address="privateIpAddress",
    propagate_tags_to_volume_on_creation=False,
    ramdisk_id="ramdiskId",
    security_group_ids=["securityGroupIds"],
    security_groups=["securityGroups"],
    source_dest_check=False,
    ssm_associations=[ec2.CfnInstance.SsmAssociationProperty(
        document_name="documentName",

        # the properties below are optional
        association_parameters=[ec2.CfnInstance.AssociationParameterProperty(
            key="key",
            value=["value"]
        )]
    )],
    subnet_id="subnetId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tenancy="tenancy",
    user_data="userData",
    volumes=[ec2.CfnInstance.VolumeProperty(
        device="device",
        volume_id="volumeId"
    )]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

CfnInstance cfnInstance = CfnInstance.Builder.create(this, "MyCfnInstance")
        .additionalInfo("additionalInfo")
        .affinity("affinity")
        .availabilityZone("availabilityZone")
        .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                .deviceName("deviceName")

                // the properties below are optional
                .ebs(EbsProperty.builder()
                        .deleteOnTermination(false)
                        .encrypted(false)
                        .iops(123)
                        .kmsKeyId("kmsKeyId")
                        .snapshotId("snapshotId")
                        .volumeSize(123)
                        .volumeType("volumeType")
                        .build())
                .noDevice(NoDeviceProperty.builder().build())
                .virtualName("virtualName")
                .build()))
        .cpuOptions(CpuOptionsProperty.builder()
                .coreCount(123)
                .threadsPerCore(123)
                .build())
        .creditSpecification(CreditSpecificationProperty.builder()
                .cpuCredits("cpuCredits")
                .build())
        .disableApiTermination(false)
        .ebsOptimized(false)
        .elasticGpuSpecifications(List.of(ElasticGpuSpecificationProperty.builder()
                .type("type")
                .build()))
        .elasticInferenceAccelerators(List.of(ElasticInferenceAcceleratorProperty.builder()
                .type("type")

                // the properties below are optional
                .count(123)
                .build()))
        .enclaveOptions(EnclaveOptionsProperty.builder()
                .enabled(false)
                .build())
        .hibernationOptions(HibernationOptionsProperty.builder()
                .configured(false)
                .build())
        .hostId("hostId")
        .hostResourceGroupArn("hostResourceGroupArn")
        .iamInstanceProfile("iamInstanceProfile")
        .imageId("imageId")
        .instanceInitiatedShutdownBehavior("instanceInitiatedShutdownBehavior")
        .instanceType("instanceType")
        .ipv6AddressCount(123)
        .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                .ipv6Address("ipv6Address")
                .build()))
        .kernelId("kernelId")
        .keyName("keyName")
        .launchTemplate(LaunchTemplateSpecificationProperty.builder()
                .version("version")

                // the properties below are optional
                .launchTemplateId("launchTemplateId")
                .launchTemplateName("launchTemplateName")
                .build())
        .licenseSpecifications(List.of(LicenseSpecificationProperty.builder()
                .licenseConfigurationArn("licenseConfigurationArn")
                .build()))
        .metadataOptions(MetadataOptionsProperty.builder()
                .httpEndpoint("httpEndpoint")
                .httpProtocolIpv6("httpProtocolIpv6")
                .httpPutResponseHopLimit(123)
                .httpTokens("httpTokens")
                .instanceMetadataTags("instanceMetadataTags")
                .build())
        .monitoring(false)
        .networkInterfaces(List.of(NetworkInterfaceProperty.builder()
                .deviceIndex("deviceIndex")

                // the properties below are optional
                .associateCarrierIpAddress(false)
                .associatePublicIpAddress(false)
                .deleteOnTermination(false)
                .description("description")
                .enaSrdSpecification(EnaSrdSpecificationProperty.builder()
                        .enaSrdEnabled(false)
                        .enaSrdUdpSpecification(EnaSrdUdpSpecificationProperty.builder()
                                .enaSrdUdpEnabled(false)
                                .build())
                        .build())
                .groupSet(List.of("groupSet"))
                .ipv6AddressCount(123)
                .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                        .ipv6Address("ipv6Address")
                        .build()))
                .networkInterfaceId("networkInterfaceId")
                .privateIpAddress("privateIpAddress")
                .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                        .primary(false)
                        .privateIpAddress("privateIpAddress")
                        .build()))
                .secondaryPrivateIpAddressCount(123)
                .subnetId("subnetId")
                .build()))
        .placementGroupName("placementGroupName")
        .privateDnsNameOptions(PrivateDnsNameOptionsProperty.builder()
                .enableResourceNameDnsAaaaRecord(false)
                .enableResourceNameDnsARecord(false)
                .hostnameType("hostnameType")
                .build())
        .privateIpAddress("privateIpAddress")
        .propagateTagsToVolumeOnCreation(false)
        .ramdiskId("ramdiskId")
        .securityGroupIds(List.of("securityGroupIds"))
        .securityGroups(List.of("securityGroups"))
        .sourceDestCheck(false)
        .ssmAssociations(List.of(SsmAssociationProperty.builder()
                .documentName("documentName")

                // the properties below are optional
                .associationParameters(List.of(AssociationParameterProperty.builder()
                        .key("key")
                        .value(List.of("value"))
                        .build()))
                .build()))
        .subnetId("subnetId")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .tenancy("tenancy")
        .userData("userData")
        .volumes(List.of(VolumeProperty.builder()
                .device("device")
                .volumeId("volumeId")
                .build()))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

var cfnInstance = new CfnInstance(this, "MyCfnInstance", new CfnInstanceProps {
    AdditionalInfo = "additionalInfo",
    Affinity = "affinity",
    AvailabilityZone = "availabilityZone",
    BlockDeviceMappings = new [] { new BlockDeviceMappingProperty {
        DeviceName = "deviceName",

        // the properties below are optional
        Ebs = new EbsProperty {
            DeleteOnTermination = false,
            Encrypted = false,
            Iops = 123,
            KmsKeyId = "kmsKeyId",
            SnapshotId = "snapshotId",
            VolumeSize = 123,
            VolumeType = "volumeType"
        },
        NoDevice = new NoDeviceProperty { },
        VirtualName = "virtualName"
    } },
    CpuOptions = new CpuOptionsProperty {
        CoreCount = 123,
        ThreadsPerCore = 123
    },
    CreditSpecification = new CreditSpecificationProperty {
        CpuCredits = "cpuCredits"
    },
    DisableApiTermination = false,
    EbsOptimized = false,
    ElasticGpuSpecifications = new [] { new ElasticGpuSpecificationProperty {
        Type = "type"
    } },
    ElasticInferenceAccelerators = new [] { new ElasticInferenceAcceleratorProperty {
        Type = "type",

        // the properties below are optional
        Count = 123
    } },
    EnclaveOptions = new EnclaveOptionsProperty {
        Enabled = false
    },
    HibernationOptions = new HibernationOptionsProperty {
        Configured = false
    },
    HostId = "hostId",
    HostResourceGroupArn = "hostResourceGroupArn",
    IamInstanceProfile = "iamInstanceProfile",
    ImageId = "imageId",
    InstanceInitiatedShutdownBehavior = "instanceInitiatedShutdownBehavior",
    InstanceType = "instanceType",
    Ipv6AddressCount = 123,
    Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
        Ipv6Address = "ipv6Address"
    } },
    KernelId = "kernelId",
    KeyName = "keyName",
    LaunchTemplate = new LaunchTemplateSpecificationProperty {
        Version = "version",

        // the properties below are optional
        LaunchTemplateId = "launchTemplateId",
        LaunchTemplateName = "launchTemplateName"
    },
    LicenseSpecifications = new [] { new LicenseSpecificationProperty {
        LicenseConfigurationArn = "licenseConfigurationArn"
    } },
    MetadataOptions = new MetadataOptionsProperty {
        HttpEndpoint = "httpEndpoint",
        HttpProtocolIpv6 = "httpProtocolIpv6",
        HttpPutResponseHopLimit = 123,
        HttpTokens = "httpTokens",
        InstanceMetadataTags = "instanceMetadataTags"
    },
    Monitoring = false,
    NetworkInterfaces = new [] { new NetworkInterfaceProperty {
        DeviceIndex = "deviceIndex",

        // the properties below are optional
        AssociateCarrierIpAddress = false,
        AssociatePublicIpAddress = false,
        DeleteOnTermination = false,
        Description = "description",
        EnaSrdSpecification = new EnaSrdSpecificationProperty {
            EnaSrdEnabled = false,
            EnaSrdUdpSpecification = new EnaSrdUdpSpecificationProperty {
                EnaSrdUdpEnabled = false
            }
        },
        GroupSet = new [] { "groupSet" },
        Ipv6AddressCount = 123,
        Ipv6Addresses = new [] { new InstanceIpv6AddressProperty {
            Ipv6Address = "ipv6Address"
        } },
        NetworkInterfaceId = "networkInterfaceId",
        PrivateIpAddress = "privateIpAddress",
        PrivateIpAddresses = new [] { new PrivateIpAddressSpecificationProperty {
            Primary = false,
            PrivateIpAddress = "privateIpAddress"
        } },
        SecondaryPrivateIpAddressCount = 123,
        SubnetId = "subnetId"
    } },
    PlacementGroupName = "placementGroupName",
    PrivateDnsNameOptions = new PrivateDnsNameOptionsProperty {
        EnableResourceNameDnsAaaaRecord = false,
        EnableResourceNameDnsARecord = false,
        HostnameType = "hostnameType"
    },
    PrivateIpAddress = "privateIpAddress",
    PropagateTagsToVolumeOnCreation = false,
    RamdiskId = "ramdiskId",
    SecurityGroupIds = new [] { "securityGroupIds" },
    SecurityGroups = new [] { "securityGroups" },
    SourceDestCheck = false,
    SsmAssociations = new [] { new SsmAssociationProperty {
        DocumentName = "documentName",

        // the properties below are optional
        AssociationParameters = new [] { new AssociationParameterProperty {
            Key = "key",
            Value = new [] { "value" }
        } }
    } },
    SubnetId = "subnetId",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Tenancy = "tenancy",
    UserData = "userData",
    Volumes = new [] { new VolumeProperty {
        Device = "device",
        VolumeId = "volumeId"
    } }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnInstance := awscdk.Aws_ec2.NewCfnInstance(this, jsii.String("MyCfnInstance"), &CfnInstanceProps{
	AdditionalInfo: jsii.String("additionalInfo"),
	Affinity: jsii.String("affinity"),
	AvailabilityZone: jsii.String("availabilityZone"),
	BlockDeviceMappings: []interface{}{
		&BlockDeviceMappingProperty{
			DeviceName: jsii.String("deviceName"),

			// the properties below are optional
			Ebs: &EbsProperty{
				DeleteOnTermination: jsii.Boolean(false),
				Encrypted: jsii.Boolean(false),
				Iops: jsii.Number(123),
				KmsKeyId: jsii.String("kmsKeyId"),
				SnapshotId: jsii.String("snapshotId"),
				VolumeSize: jsii.Number(123),
				VolumeType: jsii.String("volumeType"),
			},
			NoDevice: &NoDeviceProperty{
			},
			VirtualName: jsii.String("virtualName"),
		},
	},
	CpuOptions: &CpuOptionsProperty{
		CoreCount: jsii.Number(123),
		ThreadsPerCore: jsii.Number(123),
	},
	CreditSpecification: &CreditSpecificationProperty{
		CpuCredits: jsii.String("cpuCredits"),
	},
	DisableApiTermination: jsii.Boolean(false),
	EbsOptimized: jsii.Boolean(false),
	ElasticGpuSpecifications: []interface{}{
		&ElasticGpuSpecificationProperty{
			Type: jsii.String("type"),
		},
	},
	ElasticInferenceAccelerators: []interface{}{
		&ElasticInferenceAcceleratorProperty{
			Type: jsii.String("type"),

			// the properties below are optional
			Count: jsii.Number(123),
		},
	},
	EnclaveOptions: &EnclaveOptionsProperty{
		Enabled: jsii.Boolean(false),
	},
	HibernationOptions: &HibernationOptionsProperty{
		Configured: jsii.Boolean(false),
	},
	HostId: jsii.String("hostId"),
	HostResourceGroupArn: jsii.String("hostResourceGroupArn"),
	IamInstanceProfile: jsii.String("iamInstanceProfile"),
	ImageId: jsii.String("imageId"),
	InstanceInitiatedShutdownBehavior: jsii.String("instanceInitiatedShutdownBehavior"),
	InstanceType: jsii.String("instanceType"),
	Ipv6AddressCount: jsii.Number(123),
	Ipv6Addresses: []interface{}{
		&InstanceIpv6AddressProperty{
			Ipv6Address: jsii.String("ipv6Address"),
		},
	},
	KernelId: jsii.String("kernelId"),
	KeyName: jsii.String("keyName"),
	LaunchTemplate: &LaunchTemplateSpecificationProperty{
		Version: jsii.String("version"),

		// the properties below are optional
		LaunchTemplateId: jsii.String("launchTemplateId"),
		LaunchTemplateName: jsii.String("launchTemplateName"),
	},
	LicenseSpecifications: []interface{}{
		&LicenseSpecificationProperty{
			LicenseConfigurationArn: jsii.String("licenseConfigurationArn"),
		},
	},
	MetadataOptions: &MetadataOptionsProperty{
		HttpEndpoint: jsii.String("httpEndpoint"),
		HttpProtocolIpv6: jsii.String("httpProtocolIpv6"),
		HttpPutResponseHopLimit: jsii.Number(123),
		HttpTokens: jsii.String("httpTokens"),
		InstanceMetadataTags: jsii.String("instanceMetadataTags"),
	},
	Monitoring: jsii.Boolean(false),
	NetworkInterfaces: []interface{}{
		&NetworkInterfaceProperty{
			DeviceIndex: jsii.String("deviceIndex"),

			// the properties below are optional
			AssociateCarrierIpAddress: jsii.Boolean(false),
			AssociatePublicIpAddress: jsii.Boolean(false),
			DeleteOnTermination: jsii.Boolean(false),
			Description: jsii.String("description"),
			EnaSrdSpecification: &EnaSrdSpecificationProperty{
				EnaSrdEnabled: jsii.Boolean(false),
				EnaSrdUdpSpecification: &EnaSrdUdpSpecificationProperty{
					EnaSrdUdpEnabled: jsii.Boolean(false),
				},
			},
			GroupSet: []*string{
				jsii.String("groupSet"),
			},
			Ipv6AddressCount: jsii.Number(123),
			Ipv6Addresses: []interface{}{
				&InstanceIpv6AddressProperty{
					Ipv6Address: jsii.String("ipv6Address"),
				},
			},
			NetworkInterfaceId: jsii.String("networkInterfaceId"),
			PrivateIpAddress: jsii.String("privateIpAddress"),
			PrivateIpAddresses: []interface{}{
				&PrivateIpAddressSpecificationProperty{
					Primary: jsii.Boolean(false),
					PrivateIpAddress: jsii.String("privateIpAddress"),
				},
			},
			SecondaryPrivateIpAddressCount: jsii.Number(123),
			SubnetId: jsii.String("subnetId"),
		},
	},
	PlacementGroupName: jsii.String("placementGroupName"),
	PrivateDnsNameOptions: &PrivateDnsNameOptionsProperty{
		EnableResourceNameDnsAaaaRecord: jsii.Boolean(false),
		EnableResourceNameDnsARecord: jsii.Boolean(false),
		HostnameType: jsii.String("hostnameType"),
	},
	PrivateIpAddress: jsii.String("privateIpAddress"),
	PropagateTagsToVolumeOnCreation: jsii.Boolean(false),
	RamdiskId: jsii.String("ramdiskId"),
	SecurityGroupIds: []interface{}{
		jsii.String("securityGroupIds"),
	},
	SecurityGroups: []*string{
		jsii.String("securityGroups"),
	},
	SourceDestCheck: jsii.Boolean(false),
	SsmAssociations: []interface{}{
		&SsmAssociationProperty{
			DocumentName: jsii.String("documentName"),

			// the properties below are optional
			AssociationParameters: []interface{}{
				&AssociationParameterProperty{
					Key: jsii.String("key"),
					Value: []*string{
						jsii.String("value"),
					},
				},
			},
		},
	},
	SubnetId: jsii.String("subnetId"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	Tenancy: jsii.String("tenancy"),
	UserData: jsii.String("userData"),
	Volumes: []interface{}{
		&VolumeProperty{
			Device: jsii.String("device"),
			VolumeId: jsii.String("volumeId"),
		},
	},
})

Initializer

new CfnInstance(scope: Construct, id: string, props?: CfnInstanceProps)

CfnInstance(scope: Construct, id: str, props: typing.Optional[CfnInstanceProps] = None)

new CfnInstance(Construct scope, String id, CfnInstanceProps props)

new CfnInstance(Construct scope, string id, CfnInstanceProps? props = null)

NewCfnInstance(Scope Construct, Id *string, Props CfnInstanceProps)

Construct Props

additionalInfo?optionalstringadditional_info?optionalstradditionalInfo?optionalStringAdditionalInfo?optionalstringAdditionalInfo?optional*string#

This property is reserved for internal use.

If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX) .

affinity?optionalstringaffinity?optionalstraffinity?optionalStringAffinity?optionalstringAffinity?optional*string#

Indicates whether the instance is associated with a dedicated host.

notes

If you want the instance to always restart on the same host on which it was launched, specify host . If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default .

availabilityZone?optionalstringavailability_zone?optionalstravailabilityZone?optionalStringAvailabilityZone?optionalstringAvailabilityZone?optional*string#

The Availability Zone of the instance.

notes

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by DescribeImageAttribute .

blockDeviceMappings?optionalIResolvable | IResolvable | CfnInstance.BlockDeviceMappingProperty[]block_device_mappings?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BlockDeviceMappingProperty]]]blockDeviceMappings?optionalIResolvableBlockDeviceMappings?optionalIResolvableBlockDeviceMappings?optionalinterface{}#

The block device mapping entries that defines the block devices to attach to the instance at launch.

notes

By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the DeleteOnTermination setting.

After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement .

cpuOptions?optionalIResolvable | CfnInstance.CpuOptionsPropertycpu_options?optionaltyping.Union[IResolvable, CpuOptionsProperty]cpuOptions?optionalIResolvableCpuOptions?optionalIResolvableCpuOptions?optionalinterface{}#

The CPU options for the instance.

For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .

creditSpecification?optionalIResolvable | CfnInstance.CreditSpecificationPropertycredit_specification?optionaltyping.Union[IResolvable, CreditSpecificationProperty]creditSpecification?optionalIResolvableCreditSpecification?optionalIResolvableCreditSpecification?optionalinterface{}#

The credit option for CPU usage of the burstable performance instance.

notes

Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see Burstable performance instances in the Amazon EC2 User Guide .

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

disableApiTermination?optionalboolean | IResolvabledisable_api_termination?optionaltyping.Union[bool, IResolvable]disableApiTermination?optionalBooleanDisableApiTermination?optionalboolDisableApiTermination?optionalinterface{}#

Indicates whether termination protection is enabled for the instance.

notes

The default is false , which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

ebsOptimized?optionalboolean | IResolvableebs_optimized?optionaltyping.Union[bool, IResolvable]ebsOptimized?optionalBooleanEbsOptimized?optionalboolEbsOptimized?optionalinterface{}#

Indicates whether the instance is optimized for Amazon EBS I/O.

notes

This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

elasticGpuSpecifications?optionalIResolvable | IResolvable | CfnInstance.ElasticGpuSpecificationProperty[]elastic_gpu_specifications?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ElasticGpuSpecificationProperty]]]elasticGpuSpecifications?optionalIResolvableElasticGpuSpecifications?optionalIResolvableElasticGpuSpecifications?optionalinterface{}#

An elastic GPU to associate with the instance.

Amazon Elastic Graphics reached end of life on January 8, 2024.

elasticInferenceAccelerators?optionalIResolvable | IResolvable | CfnInstance.ElasticInferenceAcceleratorProperty[]elastic_inference_accelerators?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ElasticInferenceAcceleratorProperty]]]elasticInferenceAccelerators?optionalIResolvableElasticInferenceAccelerators?optionalIResolvableElasticInferenceAccelerators?optionalinterface{}#

An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference is no longer available.

enclaveOptions?optionalIResolvable | CfnInstance.EnclaveOptionsPropertyenclave_options?optionaltyping.Union[IResolvable, EnclaveOptionsProperty]enclaveOptions?optionalIResolvableEnclaveOptions?optionalIResolvableEnclaveOptions?optionalinterface{}#

Indicates whether the instance is enabled for AWS Nitro Enclaves.

hibernationOptions?optionalIResolvable | CfnInstance.HibernationOptionsPropertyhibernation_options?optionaltyping.Union[IResolvable, HibernationOptionsProperty]hibernationOptions?optionalIResolvableHibernationOptions?optionalIResolvableHibernationOptions?optionalinterface{}#

Indicates whether an instance is enabled for hibernation.

notes

This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide .

You can't enable hibernation and AWS Nitro Enclaves on the same instance.

hostId?optionalstring | IHostRefhost_id?optionaltyping.Union[str, IHostRef]hostId?optionalStringHostId?optionalstringHostId?optionalinterface{}#

If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.

notes

If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.

hostResourceGroupArn?optionalstringhost_resource_group_arn?optionalstrhostResourceGroupArn?optionalStringHostResourceGroupArn?optionalstringHostResourceGroupArn?optional*string#

The ARN of the host resource group in which to launch the instances.

If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

iamInstanceProfile?optionalstring | IInstanceProfileRefiam_instance_profile?optionaltyping.Union[str, IInstanceProfileRef]iamInstanceProfile?optionalStringIamInstanceProfile?optionalstringIamInstanceProfile?optionalinterface{}#

The name of an IAM instance profile.

To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.

imageId?optionalstringimage_id?optionalstrimageId?optionalStringImageId?optionalstringImageId?optional*string#

The ID of the AMI.

An AMI ID is required to launch an instance and must be specified here or in a launch template.

instanceInitiatedShutdownBehavior?optionalstringinstance_initiated_shutdown_behavior?optionalstrinstanceInitiatedShutdownBehavior?optionalStringInstanceInitiatedShutdownBehavior?optionalstringInstanceInitiatedShutdownBehavior?optional*string#

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

instanceType?optionalstringinstance_type?optionalstrinstanceType?optionalStringInstanceType?optionalstringInstanceType?optional*string#

The instance type. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .

notes

When you change your EBS-backed instance type, instance restart or replacement behavior depends on the instance type compatibility between the old and new types. An instance with an instance store volume as the root volume is always replaced. For more information, see Change the instance type in the Amazon EC2 User Guide .

ipv6AddressCount?optionalnumberipv6_address_count?optionalint | floatipv6AddressCount?optionalNumberIpv6AddressCount?optionaldoubleIpv6AddressCount?optional*float64#

The number of IPv6 addresses to associate with the primary network interface.

notes

Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

ipv6Addresses?optionalIResolvable | IResolvable | CfnInstance.InstanceIpv6AddressProperty[]ipv6_addresses?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceIpv6AddressProperty]]]ipv6Addresses?optionalIResolvableIpv6Addresses?optionalIResolvableIpv6Addresses?optionalinterface{}#

The IPv6 addresses from the range of the subnet to associate with the primary network interface.

notes

You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

kernelId?optionalstringkernel_id?optionalstrkernelId?optionalStringKernelId?optionalstringKernelId?optional*string#

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .

keyName?optionalstringkey_name?optionalstrkeyName?optionalStringKeyName?optionalstringKeyName?optional*string#

The name of the key pair. For more information, see [Create a key pair for your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html) .

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

launchTemplate?optionalIResolvable | CfnInstance.LaunchTemplateSpecificationPropertylaunch_template?optionaltyping.Union[IResolvable, LaunchTemplateSpecificationProperty]launchTemplate?optionalIResolvableLaunchTemplate?optionalIResolvableLaunchTemplate?optionalinterface{}#

The launch template.

Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

licenseSpecifications?optionalIResolvable | IResolvable | CfnInstance.LicenseSpecificationProperty[]license_specifications?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LicenseSpecificationProperty]]]licenseSpecifications?optionalIResolvableLicenseSpecifications?optionalIResolvableLicenseSpecifications?optionalinterface{}#

The license configurations.

metadataOptions?optionalIResolvable | CfnInstance.MetadataOptionsPropertymetadata_options?optionaltyping.Union[IResolvable, MetadataOptionsProperty]metadataOptions?optionalIResolvableMetadataOptions?optionalIResolvableMetadataOptions?optionalinterface{}#

The metadata options for the instance.

monitoring?optionalboolean | IResolvablemonitoring?optionaltyping.Union[bool, IResolvable]monitoring?optionalBooleanMonitoring?optionalboolMonitoring?optionalinterface{}#

Specifies whether detailed monitoring is enabled for the instance.

notes

Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide .

networkInterfaces?optionalIResolvable | IResolvable | CfnInstance.NetworkInterfaceProperty[]network_interfaces?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, NetworkInterfaceProperty]]]networkInterfaces?optionalIResolvableNetworkInterfaces?optionalIResolvableNetworkInterfaces?optionalinterface{}#

The network interfaces to associate with the instance.

notes

If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed.

If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn Attribute to declare a dependency on the VPC-gateway attachment.

placementGroupName?optionalstring | IPlacementGroupRefplacement_group_name?optionaltyping.Union[str, IPlacementGroupRef]placementGroupName?optionalStringPlacementGroupName?optionalstringPlacementGroupName?optionalinterface{}#

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).

privateDnsNameOptions?optionalIResolvable | CfnInstance.PrivateDnsNameOptionsPropertyprivate_dns_name_options?optionaltyping.Union[IResolvable, PrivateDnsNameOptionsProperty]privateDnsNameOptions?optionalIResolvablePrivateDnsNameOptions?optionalIResolvablePrivateDnsNameOptions?optionalinterface{}#

The options for the instance hostname.

privateIpAddress?optionalstringprivate_ip_address?optionalstrprivateIpAddress?optionalStringPrivateIpAddress?optionalstringPrivateIpAddress?optional*string#

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

notes

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.

propagateTagsToVolumeOnCreation?optionalboolean | IResolvablepropagate_tags_to_volume_on_creation?optionaltyping.Union[bool, IResolvable]propagateTagsToVolumeOnCreation?optionalBooleanPropagateTagsToVolumeOnCreation?optionalboolPropagateTagsToVolumeOnCreation?optionalinterface{}#

Indicates whether to assign the tags specified in the `Tags` property to the volumes specified in the `BlockDeviceMappings` property.

Note that using this feature does not assign the tags to volumes that are created separately and then attached using AWS::EC2::VolumeAttachment .

ramdiskId?optionalstringramdisk_id?optionalstrramdiskId?optionalStringRamdiskId?optionalstringRamdiskId?optional*string#

The ID of the RAM disk to select.

notes

Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .

securityGroupIds?optionalstring | ISecurityGroupRef[]security_group_ids?optionaltyping.List[typing.Union[str, ISecurityGroupRef]]securityGroupIds?optionalList<String>SecurityGroupIds?optionalstring[]SecurityGroupIds?optional*[]interface{}#

The IDs of the security groups.

You can specify the IDs of existing security groups and references to resources created by the stack template.

If you specify a network interface, you must specify any security groups as part of the network interface.

securityGroups?optionalstring[]security_groups?optionaltyping.List[str]securityGroups?optionalList<String>SecurityGroups?optionalstring[]SecurityGroups?optional*[]*string#

[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

notes

You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.

Default: Amazon EC2 uses the default security group.

sourceDestCheck?optionalboolean | IResolvablesource_dest_check?optionaltyping.Union[bool, IResolvable]sourceDestCheck?optionalBooleanSourceDestCheck?optionalboolSourceDestCheck?optionalinterface{}#

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

notes

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

ssmAssociations?optionalIResolvable | IResolvable | CfnInstance.SsmAssociationProperty[]ssm_associations?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SsmAssociationProperty]]]ssmAssociations?optionalIResolvableSsmAssociations?optionalIResolvableSsmAssociations?optionalinterface{}#

The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .

You can associate only one document with an instance.

subnetId?optionalstring | ISubnetRefsubnet_id?optionaltyping.Union[str, ISubnetRef]subnetId?optionalStringSubnetId?optionalstringSubnetId?optionalinterface{}#

The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

The tags to add to the instance.

notes

These tags are not applied to the EBS volumes, such as the root volume, unless PropagateTagsToVolumeOnCreation is true .

tenancy?optionalstringtenancy?optionalstrtenancy?optionalStringTenancy?optionalstringTenancy?optional*string#

The tenancy of the instance.

An instance with a tenancy of dedicated runs on single-tenant hardware.

userData?optionalstringuser_data?optionalstruserData?optionalStringUserData?optionalstringUserData?optional*string#

The parameters or scripts to store as user data.

notes

Any scripts in user data are run when you launch the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see Fn::Base64 .

If the root volume is an EBS volume and you update user data, CloudFormation restarts the instance. If the root volume is an instance store volume and you update user data, the instance is replaced.

volumes?optionalIResolvable | IResolvable | CfnInstance.VolumeProperty[]volumes?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VolumeProperty]]]volumes?optionalIResolvableVolumes?optionalIResolvableVolumes?optionalinterface{}#

The volumes to attach to the instance.

Properties

additionalInfo?may be undefinedstringadditional_info?may be undefinedstradditionalInfo?may be undefinedStringAdditionalInfo?may be undefinedstringAdditionalInfo?may be undefined*string#

This property is reserved for internal use.

affinity?may be undefinedstringaffinity?may be undefinedstraffinity?may be undefinedStringAffinity?may be undefinedstringAffinity?may be undefined*string#

Indicates whether the instance is associated with a dedicated host.

attrAvailabilityZonestringattr_availability_zonestrattrAvailabilityZoneStringAttrAvailabilityZonestringAttrAvailabilityZone*string#

attrInstanceIdstringattr_instance_idstrattrInstanceIdStringAttrInstanceIdstringAttrInstanceId*string#

The ID of the instance.

attrPrivateDnsNamestringattr_private_dns_namestrattrPrivateDnsNameStringAttrPrivateDnsNamestringAttrPrivateDnsName*string#

The private DNS name of the specified instance.

For example: ip-10-24-34-0.ec2.internal .

attrPrivateIpstringattr_private_ipstrattrPrivateIpStringAttrPrivateIpstringAttrPrivateIp*string#

The private IP address of the specified instance.

For example: 10.24.34.0 .

attrPublicDnsNamestringattr_public_dns_namestrattrPublicDnsNameStringAttrPublicDnsNamestringAttrPublicDnsName*string#

The public DNS name of the specified instance.

For example: ec2-107-20-50-45.compute-1.amazonaws.com .

attrPublicIpstringattr_public_ipstrattrPublicIpStringAttrPublicIpstringAttrPublicIp*string#

The public IP address of the specified instance.

For example: 192.0.2.0 .

attrStateIResolvableattr_stateIResolvableattrStateIResolvableAttrStateIResolvableAttrStateIResolvable#

The current state of the instance.

attrVpcIdstringattr_vpc_idstrattrVpcIdStringAttrVpcIdstringAttrVpcId*string#

The ID of the VPC in which the instance is running.

availabilityZone?may be undefinedstringavailability_zone?may be undefinedstravailabilityZone?may be undefinedStringAvailabilityZone?may be undefinedstringAvailabilityZone?may be undefined*string#

The Availability Zone of the instance.

blockDeviceMappings?may be undefinedIResolvable | IResolvable | CfnInstance.BlockDeviceMappingProperty[]block_device_mappings?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BlockDeviceMappingProperty]]]blockDeviceMappings?may be undefinedIResolvableBlockDeviceMappings?may be undefinedIResolvableBlockDeviceMappings?may be undefinedinterface{}#

The block device mapping entries that defines the block devices to attach to the instance at launch.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

cpuOptions?may be undefinedIResolvable | CfnInstance.CpuOptionsPropertycpu_options?may be undefinedtyping.Union[IResolvable, CpuOptionsProperty]cpuOptions?may be undefinedIResolvableCpuOptions?may be undefinedIResolvableCpuOptions?may be undefinedinterface{}#

The CPU options for the instance.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

creditSpecification?may be undefinedIResolvable | CfnInstance.CreditSpecificationPropertycredit_specification?may be undefinedtyping.Union[IResolvable, CreditSpecificationProperty]creditSpecification?may be undefinedIResolvableCreditSpecification?may be undefinedIResolvableCreditSpecification?may be undefinedinterface{}#

The credit option for CPU usage of the burstable performance instance.

disableApiTermination?may be undefinedboolean | IResolvabledisable_api_termination?may be undefinedtyping.Union[bool, IResolvable]disableApiTermination?may be undefinedBooleanDisableApiTermination?may be undefinedboolDisableApiTermination?may be undefinedinterface{}#

Indicates whether termination protection is enabled for the instance.

ebsOptimized?may be undefinedboolean | IResolvableebs_optimized?may be undefinedtyping.Union[bool, IResolvable]ebsOptimized?may be undefinedBooleanEbsOptimized?may be undefinedboolEbsOptimized?may be undefinedinterface{}#

Indicates whether the instance is optimized for Amazon EBS I/O.

elasticGpuSpecifications?may be undefinedIResolvable | IResolvable | CfnInstance.ElasticGpuSpecificationProperty[]elastic_gpu_specifications?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ElasticGpuSpecificationProperty]]]elasticGpuSpecifications?may be undefinedIResolvableElasticGpuSpecifications?may be undefinedIResolvableElasticGpuSpecifications?may be undefinedinterface{}#

An elastic GPU to associate with the instance.

elasticInferenceAccelerators?may be undefinedIResolvable | IResolvable | CfnInstance.ElasticInferenceAcceleratorProperty[]elastic_inference_accelerators?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ElasticInferenceAcceleratorProperty]]]elasticInferenceAccelerators?may be undefinedIResolvableElasticInferenceAccelerators?may be undefinedIResolvableElasticInferenceAccelerators?may be undefinedinterface{}#

An elastic inference accelerator to associate with the instance.

enclaveOptions?may be undefinedIResolvable | CfnInstance.EnclaveOptionsPropertyenclave_options?may be undefinedtyping.Union[IResolvable, EnclaveOptionsProperty]enclaveOptions?may be undefinedIResolvableEnclaveOptions?may be undefinedIResolvableEnclaveOptions?may be undefinedinterface{}#

Indicates whether the instance is enabled for AWS Nitro Enclaves.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

hibernationOptions?may be undefinedIResolvable | CfnInstance.HibernationOptionsPropertyhibernation_options?may be undefinedtyping.Union[IResolvable, HibernationOptionsProperty]hibernationOptions?may be undefinedIResolvableHibernationOptions?may be undefinedIResolvableHibernationOptions?may be undefinedinterface{}#

Indicates whether an instance is enabled for hibernation.

hostId?may be undefinedstringhost_id?may be undefinedstrhostId?may be undefinedStringHostId?may be undefinedstringHostId?may be undefined*string#

If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.

hostResourceGroupArn?may be undefinedstringhost_resource_group_arn?may be undefinedstrhostResourceGroupArn?may be undefinedStringHostResourceGroupArn?may be undefinedstringHostResourceGroupArn?may be undefined*string#

The ARN of the host resource group in which to launch the instances.

iamInstanceProfile?may be undefinedstringiam_instance_profile?may be undefinedstriamInstanceProfile?may be undefinedStringIamInstanceProfile?may be undefinedstringIamInstanceProfile?may be undefined*string#

The name of an IAM instance profile.

imageId?may be undefinedstringimage_id?may be undefinedstrimageId?may be undefinedStringImageId?may be undefinedstringImageId?may be undefined*string#

The ID of the AMI.

instanceInitiatedShutdownBehavior?may be undefinedstringinstance_initiated_shutdown_behavior?may be undefinedstrinstanceInitiatedShutdownBehavior?may be undefinedStringInstanceInitiatedShutdownBehavior?may be undefinedstringInstanceInitiatedShutdownBehavior?may be undefined*string#

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instanceRefInstanceReferenceinstance_refInstanceReferenceinstanceRefInstanceReferenceInstanceRefInstanceReferenceInstanceRefInstanceReference#

A reference to a Instance resource.

instanceType?may be undefinedstringinstance_type?may be undefinedstrinstanceType?may be undefinedStringInstanceType?may be undefinedstringInstanceType?may be undefined*string#

The instance type.

For more information, see Instance types in the Amazon EC2 User Guide .

ipv6AddressCount?may be undefinednumberipv6_address_count?may be undefinedint | floatipv6AddressCount?may be undefinedNumberIpv6AddressCount?may be undefineddoubleIpv6AddressCount?may be undefined*float64#

The number of IPv6 addresses to associate with the primary network interface.

ipv6Addresses?may be undefinedIResolvable | IResolvable | CfnInstance.InstanceIpv6AddressProperty[]ipv6_addresses?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, InstanceIpv6AddressProperty]]]ipv6Addresses?may be undefinedIResolvableIpv6Addresses?may be undefinedIResolvableIpv6Addresses?may be undefinedinterface{}#

The IPv6 addresses from the range of the subnet to associate with the primary network interface.

kernelId?may be undefinedstringkernel_id?may be undefinedstrkernelId?may be undefinedStringKernelId?may be undefinedstringKernelId?may be undefined*string#

The ID of the kernel.

keyName?may be undefinedstringkey_name?may be undefinedstrkeyName?may be undefinedStringKeyName?may be undefinedstringKeyName?may be undefined*string#

The name of the key pair.

For more information, see Create a key pair for your EC2 instance .

launchTemplate?may be undefinedIResolvable | CfnInstance.LaunchTemplateSpecificationPropertylaunch_template?may be undefinedtyping.Union[IResolvable, LaunchTemplateSpecificationProperty]launchTemplate?may be undefinedIResolvableLaunchTemplate?may be undefinedIResolvableLaunchTemplate?may be undefinedinterface{}#

The launch template.

licenseSpecifications?may be undefinedIResolvable | IResolvable | CfnInstance.LicenseSpecificationProperty[]license_specifications?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LicenseSpecificationProperty]]]licenseSpecifications?may be undefinedIResolvableLicenseSpecifications?may be undefinedIResolvableLicenseSpecifications?may be undefinedinterface{}#

The license configurations.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

metadataOptions?may be undefinedIResolvable | CfnInstance.MetadataOptionsPropertymetadata_options?may be undefinedtyping.Union[IResolvable, MetadataOptionsProperty]metadataOptions?may be undefinedIResolvableMetadataOptions?may be undefinedIResolvableMetadataOptions?may be undefinedinterface{}#

The metadata options for the instance.

monitoring?may be undefinedboolean | IResolvablemonitoring?may be undefinedtyping.Union[bool, IResolvable]monitoring?may be undefinedBooleanMonitoring?may be undefinedboolMonitoring?may be undefinedinterface{}#

Specifies whether detailed monitoring is enabled for the instance.

networkInterfaces?may be undefinedIResolvable | IResolvable | CfnInstance.NetworkInterfaceProperty[]network_interfaces?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, NetworkInterfaceProperty]]]networkInterfaces?may be undefinedIResolvableNetworkInterfaces?may be undefinedIResolvableNetworkInterfaces?may be undefinedinterface{}#

The network interfaces to associate with the instance.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

placementGroupName?may be undefinedstringplacement_group_name?may be undefinedstrplacementGroupName?may be undefinedStringPlacementGroupName?may be undefinedstringPlacementGroupName?may be undefined*string#

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).

privateDnsNameOptions?may be undefinedIResolvable | CfnInstance.PrivateDnsNameOptionsPropertyprivate_dns_name_options?may be undefinedtyping.Union[IResolvable, PrivateDnsNameOptionsProperty]privateDnsNameOptions?may be undefinedIResolvablePrivateDnsNameOptions?may be undefinedIResolvablePrivateDnsNameOptions?may be undefinedinterface{}#

The options for the instance hostname.

privateIpAddress?may be undefinedstringprivate_ip_address?may be undefinedstrprivateIpAddress?may be undefinedStringPrivateIpAddress?may be undefinedstringPrivateIpAddress?may be undefined*string#

The primary IPv4 address.

You must specify a value from the IPv4 address range of the subnet.

propagateTagsToVolumeOnCreation?may be undefinedboolean | IResolvablepropagate_tags_to_volume_on_creation?may be undefinedtyping.Union[bool, IResolvable]propagateTagsToVolumeOnCreation?may be undefinedBooleanPropagateTagsToVolumeOnCreation?may be undefinedboolPropagateTagsToVolumeOnCreation?may be undefinedinterface{}#

Indicates whether to assign the tags specified in the `Tags` property to the volumes specified in the `BlockDeviceMappings` property.

ramdiskId?may be undefinedstringramdisk_id?may be undefinedstrramdiskId?may be undefinedStringRamdiskId?may be undefinedstringRamdiskId?may be undefined*string#

The ID of the RAM disk to select.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

securityGroupIds?may be undefinedstring[]security_group_ids?may be undefinedtyping.List[str]securityGroupIds?may be undefinedList<String>SecurityGroupIds?may be undefinedstring[]SecurityGroupIds?may be undefined*[]*string#

The IDs of the security groups.

securityGroups?may be undefinedstring[]security_groups?may be undefinedtyping.List[str]securityGroups?may be undefinedList<String>SecurityGroups?may be undefinedstring[]SecurityGroups?may be undefined*[]*string#

[Default VPC] The names of the security groups.

For a nondefault VPC, you must use security group IDs instead.

sourceDestCheck?may be undefinedboolean | IResolvablesource_dest_check?may be undefinedtyping.Union[bool, IResolvable]sourceDestCheck?may be undefinedBooleanSourceDestCheck?may be undefinedboolSourceDestCheck?may be undefinedinterface{}#

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

ssmAssociations?may be undefinedIResolvable | IResolvable | CfnInstance.SsmAssociationProperty[]ssm_associations?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SsmAssociationProperty]]]ssmAssociations?may be undefinedIResolvableSsmAssociations?may be undefinedIResolvableSsmAssociations?may be undefinedinterface{}#

The SSM [document](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html) and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an IAM instance profile for Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-configuring-access-role.html) in the *AWS Systems Manager User Guide* .

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

subnetId?may be undefinedstringsubnet_id?may be undefinedstrsubnetId?may be undefinedStringSubnetId?may be undefinedstringSubnetId?may be undefined*string#

The ID of the subnet to launch the instance into.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManager#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

The tags to add to the instance.

tenancy?may be undefinedstringtenancy?may be undefinedstrtenancy?may be undefinedStringTenancy?may be undefinedstringTenancy?may be undefined*string#

The tenancy of the instance.

userData?may be undefinedstringuser_data?may be undefinedstruserData?may be undefinedStringUserData?may be undefinedstringUserData?may be undefined*string#

The parameters or scripts to store as user data.

volumes?may be undefinedIResolvable | IResolvable | CfnInstance.VolumeProperty[]volumes?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VolumeProperty]]]volumes?may be undefinedIResolvableVolumes?may be undefinedIResolvableVolumes?may be undefinedinterface{}#

The volumes to attach to the instance.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForInstance(resource: IInstanceRef): string@staticmethod def arn_for_instance(resource: IInstanceRef) -> strpublic static String arnForInstance(IInstanceRef resource)public static string ArnForInstance(IInstanceRef resource)func ArnForInstance(Resource IInstanceRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

fromInstanceId(scope: Construct, id: string, instanceId: string): IInstanceRef@staticmethod def from_instance_id(scope: Construct, id: str, instance_id: str) -> IInstanceRefpublic static IInstanceRef fromInstanceId(Construct scope, String id, String instanceId)public static IInstanceRef FromInstanceId(Construct scope, string id, string instanceId)func FromInstanceId(Scope Construct, Id *string, InstanceId *string) IInstanceRefstatic#

Creates a new IInstanceRef from a instanceId.

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnInstance(x: any): boolean@staticmethod def is_cfn_instance(x: Any) -> boolpublic static Boolean isCfnInstance(Object x)public static bool IsCfnInstance(object x)func IsCfnInstance(X interface{}) *boolstatic#

Checks whether the given object is a CfnInstance.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.