CfnInstanceProps

All Known Implementing Classes:: CfnInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:32.396Z")
public interface CfnInstanceProps

Properties for defining a `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
                 .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnInstanceProps.Builder` A builder for `CfnInstanceProps`
`static class`	`CfnInstanceProps.Jsii$Proxy` An implementation for `CfnInstanceProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnInstanceProps.Builder`	`builder()`
`default java.lang.String`	`getAdditionalInfo()` This property is reserved for internal use.
`default java.lang.String`	`getAffinity()` Indicates whether the instance is associated with a dedicated host.
`default java.lang.String`	`getAvailabilityZone()` The Availability Zone of the instance.
`default java.lang.Object`	`getBlockDeviceMappings()` The block device mapping entries that defines the block devices to attach to the instance at launch.
`default java.lang.Object`	`getCpuOptions()` The CPU options for the instance.
`default java.lang.Object`	`getCreditSpecification()` The credit option for CPU usage of the burstable performance instance.
`default 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;
`default java.lang.Object`	`getEbsOptimized()` Indicates whether the instance is optimized for Amazon EBS I/O.
`default java.lang.Object`	`getElasticGpuSpecifications()` An elastic GPU to associate with the instance.
`default java.lang.Object`	`getElasticInferenceAccelerators()` An elastic inference accelerator to associate with the instance.
`default java.lang.Object`	`getEnclaveOptions()` Indicates whether the instance is enabled for AWS Nitro Enclaves.
`default java.lang.Object`	`getHibernationOptions()` Indicates whether an instance is enabled for hibernation.
`default java.lang.String`	`getHostId()` If you specify host for the `Affinity` property, the ID of a dedicated host that the instance is associated with.
`default java.lang.String`	`getHostResourceGroupArn()` The ARN of the host resource group in which to launch the instances.
`default java.lang.String`	`getIamInstanceProfile()` The name of an IAM instance profile.
`default java.lang.String`	`getImageId()` The ID of the AMI.
`default 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).
`default java.lang.String`	`getInstanceType()` The instance type.
`default java.lang.Number`	`getIpv6AddressCount()` [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface.
`default java.lang.Object`	`getIpv6Addresses()` [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface.
`default java.lang.String`	`getKernelId()` The ID of the kernel.
`default java.lang.String`	`getKeyName()` The name of the key pair.
`default java.lang.Object`	`getLaunchTemplate()` The launch template to use to launch the instances.
`default java.lang.Object`	`getLicenseSpecifications()` The license configurations.
`default java.lang.Object`	`getMonitoring()` Specifies whether detailed monitoring is enabled for the instance.
`default java.lang.Object`	`getNetworkInterfaces()` The network interfaces to associate with the instance.
`default java.lang.String`	`getPlacementGroupName()` The name of an existing placement group that you want to launch the instance into (cluster \| partition \| spread).
`default java.lang.Object`	`getPrivateDnsNameOptions()` The options for the instance hostname.
`default java.lang.String`	`getPrivateIpAddress()` [EC2-VPC] The primary IPv4 address.
`default java.lang.Object`	`getPropagateTagsToVolumeOnCreation()` Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
`default java.lang.String`	`getRamdiskId()` The ID of the RAM disk to select.
`default java.util.List<java.lang.String>`	`getSecurityGroupIds()` The IDs of the security groups.
`default java.util.List<java.lang.String>`	`getSecurityGroups()` [EC2-Classic, default VPC] The names of the security groups.
`default 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.
`default 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.
`default java.lang.String`	`getSubnetId()` [EC2-VPC] The ID of the subnet to launch the instance into.
`default java.util.List<CfnTag>`	`getTags()` The tags to add to the instance.
`default java.lang.String`	`getTenancy()` The tenancy of the instance (if the instance is running in a VPC).
`default java.lang.String`	`getUserData()` The user data script to make available to the instance.
`default java.lang.Object`	`getVolumes()` The volumes to attach to the instance.

- Method Detail
  - getAdditionalInfo
```
default java.lang.String 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) .
  - getAffinity
```
default java.lang.String 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), specify default .
  - getAvailabilityZone
```
default java.lang.String 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 .
  - getBlockDeviceMappings
```
default java.lang.Object 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 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 .
  - getCpuOptions
```
default java.lang.Object getCpuOptions()
```
    The CPU options for the instance.
    For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
  - getCreditSpecification
```
default java.lang.Object getCreditSpecification()
```
    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 instances)
    For T3 instances with host tenancy, only standard is supported.
  - getDisableApiTermination
```
default 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;
    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
  - getEbsOptimized
```
default java.lang.Object 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
  - getElasticGpuSpecifications
```
default java.lang.Object getElasticGpuSpecifications()
```
    An elastic GPU to associate with the instance.
    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 .
  - getElasticInferenceAccelerators
```
default java.lang.Object getElasticInferenceAccelerators()
```
    An elastic inference accelerator to associate with the instance.
    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.
  - getEnclaveOptions
```
default java.lang.Object getEnclaveOptions()
```
    Indicates whether the instance is enabled for AWS Nitro Enclaves.
  - getHibernationOptions
```
default java.lang.Object getHibernationOptions()
```
    Indicates whether an instance is enabled for hibernation.
    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.
  - getHostId
```
default java.lang.String getHostId()
```
    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.
  - getHostResourceGroupArn
```
default java.lang.String 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 .
  - getIamInstanceProfile
```
default java.lang.String getIamInstanceProfile()
```
    The name of an IAM instance profile.
    To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.
  - getImageId
```
default java.lang.String 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.
  - getInstanceInitiatedShutdownBehavior
```
default 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).
    Default: stop
  - getInstanceType
```
default java.lang.String getInstanceType()
```
    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* .
    Default: m1.small
  - getIpv6AddressCount
```
default java.lang.Number getIpv6AddressCount()
```
    [EC2-VPC] 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.
  - getIpv6Addresses
```
default java.lang.Object getIpv6Addresses()
```
    [EC2-VPC] 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.
  - getKernelId
```
default java.lang.String 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 .
  - getKeyName
```
default java.lang.String getKeyName()
```
    The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.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.
  - getLaunchTemplate
```
default java.lang.Object getLaunchTemplate()
```
    The launch template to use to launch the instances.
    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.
  - getLicenseSpecifications
```
default java.lang.Object getLicenseSpecifications()
```
    The license configurations.
  - getMonitoring
```
default java.lang.Object getMonitoring()
```
    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 .
  - getNetworkInterfaces
```
default java.lang.Object 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.
  - getPlacementGroupName
```
default java.lang.String getPlacementGroupName()
```
    The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
  - getPrivateDnsNameOptions
```
default java.lang.Object getPrivateDnsNameOptions()
```
    The options for the instance hostname.
  - getPrivateIpAddress
```
default java.lang.String getPrivateIpAddress()
```
    [EC2-VPC] 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.
  - getPropagateTagsToVolumeOnCreation
```
default java.lang.Object getPropagateTagsToVolumeOnCreation()
```
    Indicates whether to assign the tags from the instance to all of the volumes attached to the instance at launch.
    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.
  - getRamdiskId
```
default java.lang.String 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 .
  - getSecurityGroupIds
```
default java.util.List<java.lang.String> getSecurityGroupIds()
```
    The IDs of the security groups. You can create a security group using [CreateSecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html) .
    If you specify a network interface, you must specify any security groups as part of the network interface.
  - getSecurityGroups
```
default java.util.List<java.lang.String> getSecurityGroups()
```
    [EC2-Classic, 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.
  - getSourceDestCheck
```
default 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.
    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.
  - getSsmAssociations
```
default 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. To use this property, you must specify an IAM instance profile role for the instance. For more information, see [Create an 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 currently associate only one document with an instance.
  - getSubnetId
```
default java.lang.String getSubnetId()
```
    [EC2-VPC] 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.
  - getTags
```
default java.util.List<CfnTag> getTags()
```
    The tags to add to the instance.
    These tags are not applied to the EBS volumes, such as the root volume.
  - getTenancy
```
default java.lang.String getTenancy()
```
    The tenancy of the instance (if the instance is running in a VPC).
    An instance with a tenancy of dedicated runs on single-tenant hardware.
  - getUserData
```
default java.lang.String getUserData()
```
    The user data script to make available to the instance.
    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.
  - getVolumes
```
default java.lang.Object getVolumes()
```
    The volumes to attach to the instance.
  - builder
```
static CfnInstanceProps.Builder builder()
```
    Returns:
    
    a CfnInstanceProps.Builder of CfnInstanceProps

Interface CfnInstanceProps

Nested Class Summary

Method Summary

Method Detail

getAdditionalInfo

getAffinity

getAvailabilityZone

getBlockDeviceMappings

getCpuOptions

getCreditSpecification

getDisableApiTermination

getEbsOptimized

getElasticGpuSpecifications

getElasticInferenceAccelerators

getEnclaveOptions

getHibernationOptions

getHostId

getHostResourceGroupArn

getIamInstanceProfile

getImageId

getInstanceInitiatedShutdownBehavior

getInstanceType

getIpv6AddressCount

getIpv6Addresses

getKernelId

getKeyName

getLaunchTemplate

getLicenseSpecifications

getMonitoring

getNetworkInterfaces

getPlacementGroupName

getPrivateDnsNameOptions

getPrivateIpAddress

getPropagateTagsToVolumeOnCreation

getRamdiskId

getSecurityGroupIds

getSecurityGroups

getSourceDestCheck

getSsmAssociations

getSubnetId

getTags

getTenancy

getUserData

getVolumes

builder