Interface CfnInstanceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnInstanceProps.Jsii$Proxy
CfnInstance.
Example:
// 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.*;
CfnInstanceProps cfnInstanceProps = CfnInstanceProps.builder()
.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()))
.monitoring(false)
.networkInterfaces(List.of(NetworkInterfaceProperty.builder()
.deviceIndex("deviceIndex")
// the properties below are optional
.associateCarrierIpAddress(false)
.associatePublicIpAddress(false)
.deleteOnTermination(false)
.description("description")
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnInstancePropsstatic final classAn implementation forCfnInstanceProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnInstanceProps.Builderbuilder()default StringThis property is reserved for internal use.default StringIndicates whether the instance is associated with a dedicated host.default StringThe Availability Zone of the instance.default ObjectThe block device mapping entries that defines the block devices to attach to the instance at launch.default ObjectThe CPU options for the instance.default ObjectThe credit option for CPU usage of the burstable performance instance.default ObjectIf you set this parameter totrue, you can't terminate the instance using the Amazon EC2 console, CLI, or API;default ObjectIndicates whether the instance is optimized for Amazon EBS I/O.default ObjectAn elastic GPU to associate with the instance.default ObjectAn elastic inference accelerator to associate with the instance.default ObjectIndicates whether the instance is enabled for AWS Nitro Enclaves.default ObjectIndicates whether an instance is enabled for hibernation.default StringIf you specify host for theAffinityproperty, the ID of a dedicated host that the instance is associated with.default StringThe ARN of the host resource group in which to launch the instances.default StringThe name of an IAM instance profile.default StringThe ID of the AMI.default StringIndicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).default StringThe instance type.default NumberThe number of IPv6 addresses to associate with the primary network interface.default ObjectThe IPv6 addresses from the range of the subnet to associate with the primary network interface.default StringThe ID of the kernel.default StringThe name of the key pair.default ObjectThe launch template.default ObjectThe license configurations.default ObjectSpecifies whether detailed monitoring is enabled for the instance.default ObjectThe network interfaces to associate with the instance.default StringThe name of an existing placement group that you want to launch the instance into (cluster | partition | spread).default ObjectThe options for the instance hostname.default StringThe primary IPv4 address.default ObjectIndicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.default StringThe ID of the RAM disk to select.The IDs of the security groups.[Default VPC] The names of the security groups.default ObjectEnable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.default ObjectThe SSM document and parameter values in AWS Systems Manager to associate with this instance.default StringThe ID of the subnet to launch the instance into.getTags()The tags to add to the instance.default StringThe tenancy of the instance.default StringThe parameters or scripts to store as user data.default ObjectThe volumes to attach to the instance.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdditionalInfo
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).- See Also:
-
getAffinity
Indicates whether the instance is associated with a dedicated host.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), specifydefault.- See Also:
-
getAvailabilityZone
The Availability Zone of the instance.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 .
- See Also:
-
getBlockDeviceMappings
The block device mapping entries that defines the block devices to attach to the instance at launch.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
DeleteOnTerminationsetting.After the instance is running, you can modify only the
DeleteOnTerminationparameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement .- See Also:
-
getCpuOptions
The CPU options for the instance.For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
- See Also:
-
getCreditSpecification
The credit option for CPU usage of the burstable performance instance.Valid values are
standardandunlimited. 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) orunlimited(T3/T3a/T4g instances)For T3 instances with
hosttenancy, onlystandardis supported.- See Also:
-
getDisableApiTermination
If you set this parameter totrue, you can't terminate the instance using the Amazon EC2 console, CLI, or API;otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute . Alternatively, if you set
InstanceInitiatedShutdownBehaviortoterminate, you can terminate the instance by running the shutdown command from the instance.Default:
false- See Also:
-
getEbsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.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- See Also:
-
getElasticGpuSpecifications
An elastic GPU to associate with the instance.Amazon Elastic Graphics reached end of life on January 8, 2024.
- See Also:
-
getElasticInferenceAccelerators
An elastic inference accelerator to associate with the instance.Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs .
- See Also:
-
getEnclaveOptions
Indicates whether the instance is enabled for AWS Nitro Enclaves.- See Also:
-
getHibernationOptions
Indicates whether an instance is enabled for hibernation.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.
- See Also:
-
getHostId
If you specify host for theAffinityproperty, the ID of a dedicated host that the instance is associated with.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.
- See Also:
-
getHostResourceGroupArn
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.- See Also:
-
getIamInstanceProfile
The name of an IAM instance profile.To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.
- See Also:
-
getImageId
The ID of the AMI.An AMI ID is required to launch an instance and must be specified here or in a launch template.
- See Also:
-
getInstanceInitiatedShutdownBehavior
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).Default:
stop- See Also:
-
getInstanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide .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 .
- See Also:
-
getIpv6AddressCount
The number of IPv6 addresses to associate with the primary network interface.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.
- See Also:
-
getIpv6Addresses
The IPv6 addresses from the range of the subnet to associate with the primary network interface.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.
- See Also:
-
getKernelId
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 .
- See Also:
-
getKeyName
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair .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.
- See Also:
-
getLaunchTemplate
The launch template.Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.
- See Also:
-
getLicenseSpecifications
The license configurations.- See Also:
-
getMonitoring
Specifies whether detailed monitoring is enabled for the instance.Specify
trueto 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 .- See Also:
-
getNetworkInterfaces
The network interfaces to associate with the instance.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.
- See Also:
-
getPlacementGroupName
The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).- See Also:
-
getPrivateDnsNameOptions
The options for the instance hostname.- See Also:
-
getPrivateIpAddress
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.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.
- See Also:
-
getPropagateTagsToVolumeOnCreation
Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.If you specify
trueand 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 specifyfalse, those tags are not assigned to the attached volumes.- See Also:
-
getRamdiskId
The ID of the RAM disk to select.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 .
- See Also:
-
getSecurityGroupIds
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.
- See Also:
-
getSecurityGroups
[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.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.
- See Also:
-
getSourceDestCheck
Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.If the value is
true, source/destination checks are enabled; otherwise, they are disabled. The default value istrue. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.- See Also:
-
getSsmAssociations
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 .You can associate only one document with an instance.
- See Also:
-
getSubnetId
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.
- See Also:
-
getTags
The tags to add to the instance.These tags are not applied to the EBS volumes, such as the root volume, unless PropagateTagsToVolumeOnCreation is
true.- See Also:
-
getTenancy
The tenancy of the instance.An instance with a tenancy of
dedicatedruns on single-tenant hardware.- See Also:
-
getUserData
The parameters or scripts to store as user data.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.
- See Also:
-
getVolumes
The volumes to attach to the instance.- See Also:
-
builder
- Returns:
- a
CfnInstanceProps.BuilderofCfnInstanceProps
-