Interface ICfnInstanceProps
Properties for defining a CfnInstance
.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnInstanceProps
Syntax (vb)
Public Interface ICfnInstanceProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html
ExampleMetadata: fixture=_generated
Examples
// 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 cfnInstanceProps = 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"
} },
Monitoring = false,
NetworkInterfaces = new [] { new NetworkInterfaceProperty {
DeviceIndex = "deviceIndex",
// the properties below are optional
AssociateCarrierIpAddress = false,
AssociatePublicIpAddress = false,
DeleteOnTermination = false,
Description = "description",
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"
} }
};
Synopsis
Properties
AdditionalInfo | This property is reserved for internal use. |
Affinity | Indicates whether the instance is associated with a dedicated host. |
AvailabilityZone | The Availability Zone of the instance. |
BlockDeviceMappings | The block device mapping entries that defines the block devices to attach to the instance at launch. |
CpuOptions | The CPU options for the instance. |
CreditSpecification | The credit option for CPU usage of the burstable performance instance. |
DisableApiTermination | If you set this parameter to |
EbsOptimized | Indicates whether the instance is optimized for Amazon EBS I/O. |
ElasticGpuSpecifications | Deprecated. |
ElasticInferenceAccelerators | An elastic inference accelerator to associate with the instance. |
EnclaveOptions | Indicates whether the instance is enabled for AWS Nitro Enclaves. |
HibernationOptions | Indicates whether an instance is enabled for hibernation. |
HostId | If you specify host for the |
HostResourceGroupArn | The ARN of the host resource group in which to launch the instances. |
IamInstanceProfile | The name of an IAM instance profile. |
ImageId | The ID of the AMI. |
InstanceInitiatedShutdownBehavior | Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). |
InstanceType | The instance type. For more information, see Instance types in the Amazon EC2 User Guide . |
Ipv6AddressCount | The number of IPv6 addresses to associate with the primary network interface. |
Ipv6Addresses | The IPv6 addresses from the range of the subnet to associate with the primary network interface. |
KernelId | The ID of the kernel. |
KeyName | The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair . |
LaunchTemplate | The launch template to use to launch the instances. |
LicenseSpecifications | The license configurations. |
Monitoring | Specifies whether detailed monitoring is enabled for the instance. |
NetworkInterfaces | The network interfaces to associate with the instance. |
PlacementGroupName | The name of an existing placement group that you want to launch the instance into (cluster | partition | spread). |
PrivateDnsNameOptions | The options for the instance hostname. |
PrivateIpAddress | The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet. |
PropagateTagsToVolumeOnCreation | Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch. |
RamdiskId | The ID of the RAM disk to select. |
SecurityGroupIds | The IDs of the security groups. |
SecurityGroups | [Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead. |
SourceDestCheck | 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 | The SSM document 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 in the AWS Systems Manager User Guide . |
SubnetId | The ID of the subnet to launch the instance into. |
Tags | The tags to add to the instance. |
Tenancy | The tenancy of the instance. |
UserData | The parameters or scripts to store as user data. |
Volumes | The volumes to attach to the instance. |
Properties
AdditionalInfo
This property is reserved for internal use.
virtual string AdditionalInfo { get; }
Property Value
System.String
Remarks
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
Indicates whether the instance is associated with a dedicated host.
virtual string Affinity { get; }
Property Value
System.String
Remarks
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
The Availability Zone of the instance.
virtual string AvailabilityZone { get; }
Property Value
System.String
Remarks
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
The block device mapping entries that defines the block devices to attach to the instance at launch.
virtual object BlockDeviceMappings { get; }
Property Value
System.Object
Remarks
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
The CPU options for the instance.
virtual object CpuOptions { get; }
Property Value
System.Object
Remarks
For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
CreditSpecification
The credit option for CPU usage of the burstable performance instance.
virtual object CreditSpecification { get; }
Property Value
System.Object
Remarks
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
If you set this parameter to true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API;
virtual object DisableApiTermination { get; }
Property Value
System.Object
Remarks
otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set InstanceInitiatedShutdownBehavior
to terminate
, you can terminate the instance by running the shutdown command from the instance.
Default: false
EbsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
virtual object EbsOptimized { get; }
Property Value
System.Object
Remarks
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
Deprecated.
virtual object ElasticGpuSpecifications { get; }
Property Value
System.Object
Remarks
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
ElasticInferenceAccelerators
An elastic inference accelerator to associate with the instance.
virtual object ElasticInferenceAccelerators { get; }
Property Value
System.Object
Remarks
Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
EnclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves.
virtual object EnclaveOptions { get; }
Property Value
System.Object
Remarks
HibernationOptions
Indicates whether an instance is enabled for hibernation.
virtual object HibernationOptions { get; }
Property Value
System.Object
Remarks
This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate your instance in the Amazon EC2 User Guide .
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
HostId
If you specify host for the Affinity
property, the ID of a dedicated host that the instance is associated with.
virtual string HostId { get; }
Property Value
System.String
Remarks
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
The ARN of the host resource group in which to launch the instances.
virtual string HostResourceGroupArn { get; }
Property Value
System.String
Remarks
If you specify a host resource group ARN, omit the Tenancy parameter or set it to host
.
IamInstanceProfile
The name of an IAM instance profile.
virtual string IamInstanceProfile { get; }
Property Value
System.String
Remarks
To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.
ImageId
The ID of the AMI.
virtual string ImageId { get; }
Property Value
System.String
Remarks
An AMI ID is required to launch an instance and must be specified here or in a launch template.
InstanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
virtual string InstanceInitiatedShutdownBehavior { get; }
Property Value
System.String
Remarks
InstanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .
virtual string InstanceType { get; }
Property Value
System.String
Remarks
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
The number of IPv6 addresses to associate with the primary network interface.
virtual Nullable<double> Ipv6AddressCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
The IPv6 addresses from the range of the subnet to associate with the primary network interface.
virtual object Ipv6Addresses { get; }
Property Value
System.Object
Remarks
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
The ID of the kernel.
virtual string KernelId { get; }
Property Value
System.String
Remarks
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
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .
virtual string KeyName { get; }
Property Value
System.String
Remarks
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
The launch template to use to launch the instances.
virtual object LaunchTemplate { get; }
Property Value
System.Object
Remarks
Any parameters that you specify in the AWS CloudFormation template override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
LicenseSpecifications
The license configurations.
virtual object LicenseSpecifications { get; }
Property Value
System.Object
Remarks
Monitoring
Specifies whether detailed monitoring is enabled for the instance.
virtual object Monitoring { get; }
Property Value
System.Object
Remarks
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
The network interfaces to associate with the instance.
virtual object NetworkInterfaces { get; }
Property Value
System.Object
Remarks
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
The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
virtual string PlacementGroupName { get; }
Property Value
System.String
Remarks
PrivateDnsNameOptions
The options for the instance hostname.
virtual object PrivateDnsNameOptions { get; }
Property Value
System.Object
Remarks
PrivateIpAddress
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
virtual string PrivateIpAddress { get; }
Property Value
System.String
Remarks
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
Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
virtual object PropagateTagsToVolumeOnCreation { get; }
Property Value
System.Object
Remarks
If you specify true
and you assign tags to the instance, those tags are automatically assigned to all of the volumes that you attach to the instance at launch. If you specify false
, those tags are not assigned to the attached volumes.
RamdiskId
The ID of the RAM disk to select.
virtual string RamdiskId { get; }
Property Value
System.String
Remarks
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
The IDs of the security groups.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
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
[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
virtual string[] SecurityGroups { get; }
Property Value
System.String[]
Remarks
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
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.
virtual object SourceDestCheck { get; }
Property Value
System.Object
Remarks
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
The SSM document 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 in the AWS Systems Manager User Guide .
virtual object SsmAssociations { get; }
Property Value
System.Object
Remarks
You can associate only one document with an instance.
SubnetId
The ID of the subnet to launch the instance into.
virtual string SubnetId { get; }
Property Value
System.String
Remarks
If you specify a network interface, you must specify any subnets as part of the network interface.
Tags
The tags to add to the instance.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
These tags are not applied to the EBS volumes, such as the root volume, unless PropagateTagsToVolumeOnCreation is true
.
Tenancy
The tenancy of the instance.
virtual string Tenancy { get; }
Property Value
System.String
Remarks
An instance with a tenancy of dedicated
runs on single-tenant hardware.
UserData
The parameters or scripts to store as user data.
virtual string UserData { get; }
Property Value
System.String
Remarks
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
The volumes to attach to the instance.
virtual object Volumes { get; }
Property Value
System.Object