Package software.amazon.awscdk.services.ec2

Class CfnInstanceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.CfnInstanceProps.Jsii$Proxy

All Implemented Interfaces:

CfnInstanceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnInstanceProps

@Stability(Stable)
@Internal
public static final class CfnInstanceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnInstanceProps

An implementation for CfnInstanceProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.CfnInstanceProps

CfnInstanceProps.Builder, CfnInstanceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnInstanceProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnInstanceProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAdditionalInfo()	This property is reserved for internal use.
final String	getAffinity()	Indicates whether the instance is associated with a dedicated host.
final String	getAvailabilityZone()	The Availability Zone of the instance.
final Object	getBlockDeviceMappings()	The block device mapping entries that defines the block devices to attach to the instance at launch.
final Object	getCpuOptions()	The CPU options for the instance.
final Object	getCreditSpecification()	The credit option for CPU usage of the burstable performance instance.
final Object	getDisableApiTermination()	Indicates whether termination protection is enabled for the instance.
final Object	getEbsOptimized()	Indicates whether the instance is optimized for Amazon EBS I/O.
final Object	getElasticGpuSpecifications()	An elastic GPU to associate with the instance.
final Object	getElasticInferenceAccelerators()	An elastic inference accelerator to associate with the instance.
final Object	getEnclaveOptions()	Indicates whether the instance is enabled for AWS Nitro Enclaves.
final Object	getHibernationOptions()	Indicates whether an instance is enabled for hibernation.
final String	getHostId()	If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with.
final String	getHostResourceGroupArn()	The ARN of the host resource group in which to launch the instances.
final String	getIamInstanceProfile()	The name of an IAM instance profile.
final String	getImageId()	The ID of the AMI.
final String	getInstanceInitiatedShutdownBehavior()	Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
final String	getInstanceType()	The instance type.
final Number	getIpv6AddressCount()	The number of IPv6 addresses to associate with the primary network interface.
final Object	getIpv6Addresses()	The IPv6 addresses from the range of the subnet to associate with the primary network interface.
final String	getKernelId()	The ID of the kernel.
final String	getKeyName()	The name of the key pair.
final Object	getLaunchTemplate()	The launch template.
final Object	getLicenseSpecifications()	The license configurations.
final Object	getMonitoring()	Specifies whether detailed monitoring is enabled for the instance.
final Object	getNetworkInterfaces()	The network interfaces to associate with the instance.
final String	getPlacementGroupName()	The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
final Object	getPrivateDnsNameOptions()	The options for the instance hostname.
final String	getPrivateIpAddress()	The primary IPv4 address.
final Object	getPropagateTagsToVolumeOnCreation()	Indicates whether to assign the tags specified in the Tags property to the volumes specified in the BlockDeviceMappings property.
final String	getRamdiskId()	The ID of the RAM disk to select.
final List<String>	getSecurityGroupIds()	The IDs of the security groups.
final List<String>	getSecurityGroups()	[Default VPC] The names of the security groups.
final Object	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.
final Object	getSsmAssociations()	The SSM document and parameter values in AWS Systems Manager to associate with this instance.
final String	getSubnetId()	The ID of the subnet to launch the instance into.
final List<CfnTag>	getTags()	The tags to add to the instance.
final String	getTenancy()	The tenancy of the instance.
final String	getUserData()	The parameters or scripts to store as user data.
final Object	getVolumes()	The volumes to attach to the instance.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnInstanceProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnInstanceProps.Builder.

Method Details

getAdditionalInfo

public final String getAdditionalInfo()

Description copied from interface: CfnInstanceProps

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

Specified by:

getAdditionalInfo in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-additionalinfo

getAffinity

public final String getAffinity()

Description copied from interface: CfnInstanceProps

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), specify default .

Specified by:

getAffinity in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-affinity

getAvailabilityZone

public final String getAvailabilityZone()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getAvailabilityZone in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-availabilityzone

getBlockDeviceMappings

public final Object getBlockDeviceMappings()

Description copied from interface: CfnInstanceProps

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

Specified by:

getBlockDeviceMappings in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-blockdevicemappings

getCpuOptions

public final Object getCpuOptions()

Description copied from interface: CfnInstanceProps

The CPU options for the instance.

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

Specified by:

getCpuOptions in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-cpuoptions

getCreditSpecification

public final Object getCreditSpecification()

Description copied from interface: CfnInstanceProps

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

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.

Specified by:

getCreditSpecification in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-creditspecification

getDisableApiTermination

public final Object getDisableApiTermination()

Description copied from interface: CfnInstanceProps

Indicates whether termination protection is enabled for the instance.

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.

Specified by:

getDisableApiTermination in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-disableapitermination

getEbsOptimized

public final Object getEbsOptimized()

Description copied from interface: CfnInstanceProps

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

Specified by:

getEbsOptimized in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ebsoptimized

getElasticGpuSpecifications

public final Object getElasticGpuSpecifications()

Description copied from interface: CfnInstanceProps

An elastic GPU to associate with the instance.

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

Specified by:

getElasticGpuSpecifications in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticgpuspecifications

getElasticInferenceAccelerators

public final Object getElasticInferenceAccelerators()

Description copied from interface: CfnInstanceProps

An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference is no longer available.

Specified by:

getElasticInferenceAccelerators in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-elasticinferenceaccelerators

getEnclaveOptions

public final Object getEnclaveOptions()

Description copied from interface: CfnInstanceProps

Indicates whether the instance is enabled for AWS Nitro Enclaves.

Specified by:

getEnclaveOptions in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-enclaveoptions

getHibernationOptions

public final Object getHibernationOptions()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getHibernationOptions in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hibernationoptions

getHostId

public final String getHostId()

Description copied from interface: CfnInstanceProps

If you specify host for the Affinity property, 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.

Specified by:

getHostId in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostid

getHostResourceGroupArn

public final String getHostResourceGroupArn()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getHostResourceGroupArn in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-hostresourcegrouparn

getIamInstanceProfile

public final String getIamInstanceProfile()

Description copied from interface: CfnInstanceProps

The name of an IAM instance profile.

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

Specified by:

getIamInstanceProfile in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-iaminstanceprofile

getImageId

public final String getImageId()

Description copied from interface: CfnInstanceProps

The ID of the AMI.

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

Specified by:

getImageId in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-imageid

getInstanceInitiatedShutdownBehavior

public final String getInstanceInitiatedShutdownBehavior()

Description copied from interface: CfnInstanceProps

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

Default: stop

Specified by:

getInstanceInitiatedShutdownBehavior in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instanceinitiatedshutdownbehavior

getInstanceType

public final String getInstanceType()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getInstanceType in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-instancetype

getIpv6AddressCount

public final Number getIpv6AddressCount()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getIpv6AddressCount in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresscount

getIpv6Addresses

public final Object getIpv6Addresses()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getIpv6Addresses in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ipv6addresses

getKernelId

public final String getKernelId()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getKernelId in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-kernelid

getKeyName

public final String getKeyName()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getKeyName in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-keyname

getLaunchTemplate

public final Object getLaunchTemplate()

Description copied from interface: CfnInstanceProps

The launch template.

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

Specified by:

getLaunchTemplate in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-launchtemplate

getLicenseSpecifications

public final Object getLicenseSpecifications()

Description copied from interface: CfnInstanceProps

The license configurations.

Specified by:

getLicenseSpecifications in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-licensespecifications

getMonitoring

public final Object getMonitoring()

Description copied from interface: CfnInstanceProps

Specifies whether detailed monitoring is enabled for the instance.

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 .

Specified by:

getMonitoring in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-monitoring

getNetworkInterfaces

public final Object getNetworkInterfaces()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getNetworkInterfaces in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-networkinterfaces

getPlacementGroupName

public final String getPlacementGroupName()

Description copied from interface: CfnInstanceProps

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

Specified by:

getPlacementGroupName in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-placementgroupname

getPrivateDnsNameOptions

public final Object getPrivateDnsNameOptions()

Description copied from interface: CfnInstanceProps

The options for the instance hostname.

Specified by:

getPrivateDnsNameOptions in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privatednsnameoptions

getPrivateIpAddress

public final String getPrivateIpAddress()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getPrivateIpAddress in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-privateipaddress

getPropagateTagsToVolumeOnCreation

public final Object getPropagateTagsToVolumeOnCreation()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getPropagateTagsToVolumeOnCreation in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-propagatetagstovolumeoncreation

getRamdiskId

public final String getRamdiskId()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getRamdiskId in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ramdiskid

getSecurityGroupIds

public final List<String> getSecurityGroupIds()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getSecurityGroupIds in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroupids

getSecurityGroups

public final List<String> getSecurityGroups()

Description copied from interface: CfnInstanceProps

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

Specified by:

getSecurityGroups in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-securitygroups

getSourceDestCheck

public final Object getSourceDestCheck()

Description copied from interface: CfnInstanceProps

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 is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Specified by:

getSourceDestCheck in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-sourcedestcheck

getSsmAssociations

public final Object getSsmAssociations()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getSsmAssociations in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-ssmassociations

getSubnetId

public final String getSubnetId()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getSubnetId in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-subnetid

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnInstanceProps

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 .

Specified by:

getTags in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tags

getTenancy

public final String getTenancy()

Description copied from interface: CfnInstanceProps

The tenancy of the instance.

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

Specified by:

getTenancy in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-tenancy

getUserData

public final String getUserData()

Description copied from interface: CfnInstanceProps

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.

Specified by:

getUserData in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-userdata

getVolumes

public final Object getVolumes()

Description copied from interface: CfnInstanceProps

The volumes to attach to the instance.

Specified by:

getVolumes in interface CfnInstanceProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instance.html#cfn-ec2-instance-volumes

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object