public static final class CfnInstanceProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnInstanceProps
CfnInstanceProps
CfnInstanceProps.Builder, CfnInstanceProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getAdditionalInfo()
This property is reserved for internal use.
|
java.lang.String |
getAffinity()
Indicates whether the instance is associated with a dedicated host.
|
java.lang.String |
getAvailabilityZone()
The Availability Zone of the instance.
|
java.lang.Object |
getBlockDeviceMappings()
The block device mapping entries that defines the block devices to attach to the instance at launch.
|
java.lang.Object |
getCpuOptions()
The CPU options for the instance.
|
java.lang.Object |
getCreditSpecification()
The credit option for CPU usage of the burstable performance instance.
|
java.lang.Object |
getDisableApiTermination()
If you set this parameter to `true` , you can't terminate the instance using the Amazon EC2 console, CLI, or API;
|
java.lang.Object |
getEbsOptimized()
Indicates whether the instance is optimized for Amazon EBS I/O.
|
java.lang.Object |
getElasticGpuSpecifications()
An elastic GPU to associate with the instance.
|
java.lang.Object |
getElasticInferenceAccelerators()
An elastic inference accelerator to associate with the instance.
|
java.lang.Object |
getEnclaveOptions()
Indicates whether the instance is enabled for AWS Nitro Enclaves.
|
java.lang.Object |
getHibernationOptions()
Indicates whether an instance is enabled for hibernation.
|
java.lang.String |
getHostId()
If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.
|
java.lang.String |
getHostResourceGroupArn()
The ARN of the host resource group in which to launch the instances.
|
java.lang.String |
getIamInstanceProfile()
The name of an IAM instance profile.
|
java.lang.String |
getImageId()
The ID of the AMI.
|
java.lang.String |
getInstanceInitiatedShutdownBehavior()
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
|
java.lang.String |
getInstanceType()
The instance type.
|
java.lang.Number |
getIpv6AddressCount()
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface.
|
java.lang.Object |
getIpv6Addresses()
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
|
java.lang.String |
getKernelId()
The ID of the kernel.
|
java.lang.String |
getKeyName()
The name of the key pair.
|
java.lang.Object |
getLaunchTemplate()
The launch template to use to launch the instances.
|
java.lang.Object |
getLicenseSpecifications()
The license configurations.
|
java.lang.Object |
getMonitoring()
Specifies whether detailed monitoring is enabled for the instance.
|
java.lang.Object |
getNetworkInterfaces()
The network interfaces to associate with the instance.
|
java.lang.String |
getPlacementGroupName()
The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
|
java.lang.Object |
getPrivateDnsNameOptions()
The options for the instance hostname.
|
java.lang.String |
getPrivateIpAddress()
[EC2-VPC] The primary IPv4 address.
|
java.lang.Object |
getPropagateTagsToVolumeOnCreation()
Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
|
java.lang.String |
getRamdiskId()
The ID of the RAM disk to select.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
The IDs of the security groups.
|
java.util.List<java.lang.String> |
getSecurityGroups()
[EC2-Classic, default VPC] The names of the security groups.
|
java.lang.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.
|
java.lang.Object |
getSsmAssociations()
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.
|
java.lang.String |
getSubnetId()
[EC2-VPC] The ID of the subnet to launch the instance into.
|
java.util.List<CfnTag> |
getTags()
The tags to add to the instance.
|
java.lang.String |
getTenancy()
The tenancy of the instance (if the instance is running in a VPC).
|
java.lang.String |
getUserData()
The user data script to make available to the instance.
|
java.lang.Object |
getVolumes()
The volumes to attach to the instance.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.String getAdditionalInfo()
CfnInstanceProps
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)
.
getAdditionalInfo
in interface CfnInstanceProps
public final java.lang.String getAffinity()
CfnInstanceProps
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
.
getAffinity
in interface CfnInstanceProps
public final java.lang.String getAvailabilityZone()
CfnInstanceProps
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 .
getAvailabilityZone
in interface CfnInstanceProps
public final java.lang.Object getBlockDeviceMappings()
CfnInstanceProps
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 .
getBlockDeviceMappings
in interface CfnInstanceProps
public final java.lang.Object getCpuOptions()
CfnInstanceProps
For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
getCpuOptions
in interface CfnInstanceProps
public final java.lang.Object getCreditSpecification()
CfnInstanceProps
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 instances)
For T3 instances with host
tenancy, only standard
is supported.
getCreditSpecification
in interface CfnInstanceProps
public final java.lang.Object getDisableApiTermination()
CfnInstanceProps
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
getDisableApiTermination
in interface CfnInstanceProps
public final java.lang.Object getEbsOptimized()
CfnInstanceProps
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
getEbsOptimized
in interface CfnInstanceProps
public final java.lang.Object getElasticGpuSpecifications()
CfnInstanceProps
An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide .
getElasticGpuSpecifications
in interface CfnInstanceProps
public final java.lang.Object getElasticInferenceAccelerators()
CfnInstanceProps
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.
getElasticInferenceAccelerators
in interface CfnInstanceProps
public final java.lang.Object getEnclaveOptions()
CfnInstanceProps
getEnclaveOptions
in interface CfnInstanceProps
public final java.lang.Object getHibernationOptions()
CfnInstanceProps
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.
getHibernationOptions
in interface CfnInstanceProps
public final java.lang.String getHostId()
CfnInstanceProps
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.
getHostId
in interface CfnInstanceProps
public final java.lang.String getHostResourceGroupArn()
CfnInstanceProps
If you specify a host resource group ARN, omit the Tenancy parameter or set it to host
.
getHostResourceGroupArn
in interface CfnInstanceProps
public final java.lang.String getIamInstanceProfile()
CfnInstanceProps
To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.
getIamInstanceProfile
in interface CfnInstanceProps
public final java.lang.String getImageId()
CfnInstanceProps
An AMI ID is required to launch an instance and must be specified here or in a launch template.
getImageId
in interface CfnInstanceProps
public final java.lang.String getInstanceInitiatedShutdownBehavior()
CfnInstanceProps
Default: stop
getInstanceInitiatedShutdownBehavior
in interface CfnInstanceProps
public final java.lang.String getInstanceType()
CfnInstanceProps
Default: m1.small
getInstanceType
in interface CfnInstanceProps
public final java.lang.Number getIpv6AddressCount()
CfnInstanceProps
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.
getIpv6AddressCount
in interface CfnInstanceProps
public final java.lang.Object getIpv6Addresses()
CfnInstanceProps
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.
getIpv6Addresses
in interface CfnInstanceProps
public final java.lang.String getKernelId()
CfnInstanceProps
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 .
getKernelId
in interface CfnInstanceProps
public final java.lang.String getKeyName()
CfnInstanceProps
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.
getKeyName
in interface CfnInstanceProps
public final java.lang.Object getLaunchTemplate()
CfnInstanceProps
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.
getLaunchTemplate
in interface CfnInstanceProps
public final java.lang.Object getLicenseSpecifications()
CfnInstanceProps
getLicenseSpecifications
in interface CfnInstanceProps
public final java.lang.Object getMonitoring()
CfnInstanceProps
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 .
getMonitoring
in interface CfnInstanceProps
public final java.lang.Object getNetworkInterfaces()
CfnInstanceProps
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.
getNetworkInterfaces
in interface CfnInstanceProps
public final java.lang.String getPlacementGroupName()
CfnInstanceProps
getPlacementGroupName
in interface CfnInstanceProps
public final java.lang.Object getPrivateDnsNameOptions()
CfnInstanceProps
getPrivateDnsNameOptions
in interface CfnInstanceProps
public final java.lang.String getPrivateIpAddress()
CfnInstanceProps
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.
getPrivateIpAddress
in interface CfnInstanceProps
public final java.lang.Object getPropagateTagsToVolumeOnCreation()
CfnInstanceProps
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.
getPropagateTagsToVolumeOnCreation
in interface CfnInstanceProps
public final java.lang.String getRamdiskId()
CfnInstanceProps
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 .
getRamdiskId
in interface CfnInstanceProps
public final java.util.List<java.lang.String> getSecurityGroupIds()
CfnInstanceProps
If you specify a network interface, you must specify any security groups as part of the network interface.
getSecurityGroupIds
in interface CfnInstanceProps
public final java.util.List<java.lang.String> getSecurityGroups()
CfnInstanceProps
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.
getSecurityGroups
in interface CfnInstanceProps
public final java.lang.Object getSourceDestCheck()
CfnInstanceProps
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.
getSourceDestCheck
in interface CfnInstanceProps
public final java.lang.Object getSsmAssociations()
CfnInstanceProps
You can currently associate only one document with an instance.
getSsmAssociations
in interface CfnInstanceProps
public final java.lang.String getSubnetId()
CfnInstanceProps
If you specify a network interface, you must specify any subnets as part of the network interface.
getSubnetId
in interface CfnInstanceProps
public final java.util.List<CfnTag> getTags()
CfnInstanceProps
These tags are not applied to the EBS volumes, such as the root volume.
getTags
in interface CfnInstanceProps
public final java.lang.String getTenancy()
CfnInstanceProps
An instance with a tenancy of dedicated
runs on single-tenant hardware.
getTenancy
in interface CfnInstanceProps
public final java.lang.String getUserData()
CfnInstanceProps
For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch . If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
getUserData
in interface CfnInstanceProps
public final java.lang.Object getVolumes()
CfnInstanceProps
getVolumes
in interface CfnInstanceProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()