Package software.amazon.awscdk.services.ec2

Class CfnInstanceProps.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.CfnInstanceProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnInstanceProps>
Enclosing interface:
CfnInstanceProps
@Stability(Stable) public static final class CfnInstanceProps.Builder extends Object implements software.amazon.jsii.Builder<CfnInstanceProps>
A builder for CfnInstanceProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • additionalInfo

      @Stability(Stable) public CfnInstanceProps.Builder additionalInfo(String additionalInfo)
      Sets the value of CfnInstanceProps.getAdditionalInfo()
      Parameters:
      additionalInfo - 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) .
      Returns:
      this

    • affinity

      @Stability(Stable) public CfnInstanceProps.Builder affinity(String affinity)
      Sets the value of CfnInstanceProps.getAffinity()
      Parameters:
      affinity - 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 .
      Returns:
      this

    • availabilityZone

      @Stability(Stable) public CfnInstanceProps.Builder availabilityZone(String availabilityZone)
      Sets the value of CfnInstanceProps.getAvailabilityZone()
      Parameters:
      availabilityZone - 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 .

      Returns:
      this

    • blockDeviceMappings

      @Stability(Stable) public CfnInstanceProps.Builder blockDeviceMappings(IResolvable blockDeviceMappings)
      Sets the value of CfnInstanceProps.getBlockDeviceMappings()
      Parameters:
      blockDeviceMappings - 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 .

      Returns:
      this

    • blockDeviceMappings

      @Stability(Stable) public CfnInstanceProps.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)
      Sets the value of CfnInstanceProps.getBlockDeviceMappings()
      Parameters:
      blockDeviceMappings - 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 .

      Returns:
      this

    • cpuOptions

      @Stability(Stable) public CfnInstanceProps.Builder cpuOptions(IResolvable cpuOptions)
      Sets the value of CfnInstanceProps.getCpuOptions()
      Parameters:
      cpuOptions - The CPU options for the instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
      Returns:
      this

    • cpuOptions

      @Stability(Stable) public CfnInstanceProps.Builder cpuOptions(CfnInstance.CpuOptionsProperty cpuOptions)
      Sets the value of CfnInstanceProps.getCpuOptions()
      Parameters:
      cpuOptions - The CPU options for the instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .
      Returns:
      this

    • creditSpecification

      @Stability(Stable) public CfnInstanceProps.Builder creditSpecification(IResolvable creditSpecification)
      Sets the value of CfnInstanceProps.getCreditSpecification()
      Parameters:
      creditSpecification - 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.

      Returns:
      this

    • creditSpecification

      @Stability(Stable) public CfnInstanceProps.Builder creditSpecification(CfnInstance.CreditSpecificationProperty creditSpecification)
      Sets the value of CfnInstanceProps.getCreditSpecification()
      Parameters:
      creditSpecification - 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.

      Returns:
      this

    • disableApiTermination

      @Stability(Stable) public CfnInstanceProps.Builder disableApiTermination(Boolean disableApiTermination)
      Sets the value of CfnInstanceProps.getDisableApiTermination()
      Parameters:
      disableApiTermination - 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

      Returns:
      this

    • disableApiTermination

      @Stability(Stable) public CfnInstanceProps.Builder disableApiTermination(IResolvable disableApiTermination)
      Sets the value of CfnInstanceProps.getDisableApiTermination()
      Parameters:
      disableApiTermination - 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

      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnInstanceProps.Builder ebsOptimized(Boolean ebsOptimized)
      Sets the value of CfnInstanceProps.getEbsOptimized()
      Parameters:
      ebsOptimized - 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

      Returns:
      this

    • ebsOptimized

      @Stability(Stable) public CfnInstanceProps.Builder ebsOptimized(IResolvable ebsOptimized)
      Sets the value of CfnInstanceProps.getEbsOptimized()
      Parameters:
      ebsOptimized - 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

      Returns:
      this

    • elasticGpuSpecifications

      @Stability(Stable) public CfnInstanceProps.Builder elasticGpuSpecifications(IResolvable elasticGpuSpecifications)
      Sets the value of CfnInstanceProps.getElasticGpuSpecifications()
      Parameters:
      elasticGpuSpecifications - 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 .
      Returns:
      this

    • elasticGpuSpecifications

      @Stability(Stable) public CfnInstanceProps.Builder elasticGpuSpecifications(List<? extends Object> elasticGpuSpecifications)
      Sets the value of CfnInstanceProps.getElasticGpuSpecifications()
      Parameters:
      elasticGpuSpecifications - 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 .
      Returns:
      this

    • elasticInferenceAccelerators

      @Stability(Stable) public CfnInstanceProps.Builder elasticInferenceAccelerators(IResolvable elasticInferenceAccelerators)
      Sets the value of CfnInstanceProps.getElasticInferenceAccelerators()
      Parameters:
      elasticInferenceAccelerators - 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.

      Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

      Returns:
      this

    • elasticInferenceAccelerators

      @Stability(Stable) public CfnInstanceProps.Builder elasticInferenceAccelerators(List<? extends Object> elasticInferenceAccelerators)
      Sets the value of CfnInstanceProps.getElasticInferenceAccelerators()
      Parameters:
      elasticInferenceAccelerators - 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.

      Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

      Returns:
      this

    • enclaveOptions

      @Stability(Stable) public CfnInstanceProps.Builder enclaveOptions(IResolvable enclaveOptions)
      Sets the value of CfnInstanceProps.getEnclaveOptions()
      Parameters:
      enclaveOptions - Indicates whether the instance is enabled for AWS Nitro Enclaves.
      Returns:
      this

    • enclaveOptions

      @Stability(Stable) public CfnInstanceProps.Builder enclaveOptions(CfnInstance.EnclaveOptionsProperty enclaveOptions)
      Sets the value of CfnInstanceProps.getEnclaveOptions()
      Parameters:
      enclaveOptions - Indicates whether the instance is enabled for AWS Nitro Enclaves.
      Returns:
      this

    • hibernationOptions

      @Stability(Stable) public CfnInstanceProps.Builder hibernationOptions(IResolvable hibernationOptions)
      Sets the value of CfnInstanceProps.getHibernationOptions()
      Parameters:
      hibernationOptions - 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.

      Returns:
      this

    • hibernationOptions

      @Stability(Stable) public CfnInstanceProps.Builder hibernationOptions(CfnInstance.HibernationOptionsProperty hibernationOptions)
      Sets the value of CfnInstanceProps.getHibernationOptions()
      Parameters:
      hibernationOptions - 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.

      Returns:
      this

    • hostId

      @Stability(Stable) public CfnInstanceProps.Builder hostId(String hostId)
      Sets the value of CfnInstanceProps.getHostId()
      Parameters:
      hostId - 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.
      Returns:
      this

    • hostResourceGroupArn

      @Stability(Stable) public CfnInstanceProps.Builder hostResourceGroupArn(String hostResourceGroupArn)
      Sets the value of CfnInstanceProps.getHostResourceGroupArn()
      Parameters:
      hostResourceGroupArn - 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 .
      Returns:
      this

    • iamInstanceProfile

      @Stability(Stable) public CfnInstanceProps.Builder iamInstanceProfile(String iamInstanceProfile)
      Sets the value of CfnInstanceProps.getIamInstanceProfile()
      Parameters:
      iamInstanceProfile - The name of an IAM instance profile. To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.
      Returns:
      this

    • imageId

      @Stability(Stable) public CfnInstanceProps.Builder imageId(String imageId)
      Sets the value of CfnInstanceProps.getImageId()
      Parameters:
      imageId - The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
      Returns:
      this

    • instanceInitiatedShutdownBehavior

      @Stability(Stable) public CfnInstanceProps.Builder instanceInitiatedShutdownBehavior(String instanceInitiatedShutdownBehavior)
      Sets the value of CfnInstanceProps.getInstanceInitiatedShutdownBehavior()
      Parameters:
      instanceInitiatedShutdownBehavior - Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Default: stop
      Returns:
      this

    • instanceType

      @Stability(Stable) public CfnInstanceProps.Builder instanceType(String instanceType)
      Sets the value of CfnInstanceProps.getInstanceType()
      Parameters:
      instanceType - The instance type. For more information, see Instance types in the Amazon EC2 User Guide . Default: m1.small
      Returns:
      this

    • ipv6AddressCount

      @Stability(Stable) public CfnInstanceProps.Builder ipv6AddressCount(Number ipv6AddressCount)
      Sets the value of CfnInstanceProps.getIpv6AddressCount()
      Parameters:
      ipv6AddressCount - 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.

      Returns:
      this

    • ipv6Addresses

      @Stability(Stable) public CfnInstanceProps.Builder ipv6Addresses(IResolvable ipv6Addresses)
      Sets the value of CfnInstanceProps.getIpv6Addresses()
      Parameters:
      ipv6Addresses - 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.

      Returns:
      this

    • ipv6Addresses

      @Stability(Stable) public CfnInstanceProps.Builder ipv6Addresses(List<? extends Object> ipv6Addresses)
      Sets the value of CfnInstanceProps.getIpv6Addresses()
      Parameters:
      ipv6Addresses - 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.

      Returns:
      this

    • kernelId

      @Stability(Stable) public CfnInstanceProps.Builder kernelId(String kernelId)
      Sets the value of CfnInstanceProps.getKernelId()
      Parameters:
      kernelId - 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 .

      Returns:
      this

    • keyName

      @Stability(Stable) public CfnInstanceProps.Builder keyName(String keyName)
      Sets the value of CfnInstanceProps.getKeyName()
      Parameters:
      keyName - 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.

      Returns:
      this

    • launchTemplate

      @Stability(Stable) public CfnInstanceProps.Builder launchTemplate(IResolvable launchTemplate)
      Sets the value of CfnInstanceProps.getLaunchTemplate()
      Parameters:
      launchTemplate - 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.
      Returns:
      this

    • launchTemplate

      @Stability(Stable) public CfnInstanceProps.Builder launchTemplate(CfnInstance.LaunchTemplateSpecificationProperty launchTemplate)
      Sets the value of CfnInstanceProps.getLaunchTemplate()
      Parameters:
      launchTemplate - 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.
      Returns:
      this

    • licenseSpecifications

      @Stability(Stable) public CfnInstanceProps.Builder licenseSpecifications(IResolvable licenseSpecifications)
      Sets the value of CfnInstanceProps.getLicenseSpecifications()
      Parameters:
      licenseSpecifications - The license configurations.
      Returns:
      this

    • licenseSpecifications

      @Stability(Stable) public CfnInstanceProps.Builder licenseSpecifications(List<? extends Object> licenseSpecifications)
      Sets the value of CfnInstanceProps.getLicenseSpecifications()
      Parameters:
      licenseSpecifications - The license configurations.
      Returns:
      this

    • monitoring

      @Stability(Stable) public CfnInstanceProps.Builder monitoring(Boolean monitoring)
      Sets the value of CfnInstanceProps.getMonitoring()
      Parameters:
      monitoring - 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 .
      Returns:
      this

    • monitoring

      @Stability(Stable) public CfnInstanceProps.Builder monitoring(IResolvable monitoring)
      Sets the value of CfnInstanceProps.getMonitoring()
      Parameters:
      monitoring - 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 .
      Returns:
      this

    • networkInterfaces

      @Stability(Stable) public CfnInstanceProps.Builder networkInterfaces(IResolvable networkInterfaces)
      Sets the value of CfnInstanceProps.getNetworkInterfaces()
      Parameters:
      networkInterfaces - 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.

      Returns:
      this

    • networkInterfaces

      @Stability(Stable) public CfnInstanceProps.Builder networkInterfaces(List<? extends Object> networkInterfaces)
      Sets the value of CfnInstanceProps.getNetworkInterfaces()
      Parameters:
      networkInterfaces - 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.

      Returns:
      this

    • placementGroupName

      @Stability(Stable) public CfnInstanceProps.Builder placementGroupName(String placementGroupName)
      Sets the value of CfnInstanceProps.getPlacementGroupName()
      Parameters:
      placementGroupName - The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).
      Returns:
      this

    • privateDnsNameOptions

      @Stability(Stable) public CfnInstanceProps.Builder privateDnsNameOptions(IResolvable privateDnsNameOptions)
      Sets the value of CfnInstanceProps.getPrivateDnsNameOptions()
      Parameters:
      privateDnsNameOptions - The options for the instance hostname.
      Returns:
      this

    • privateDnsNameOptions

      @Stability(Stable) public CfnInstanceProps.Builder privateDnsNameOptions(CfnInstance.PrivateDnsNameOptionsProperty privateDnsNameOptions)
      Sets the value of CfnInstanceProps.getPrivateDnsNameOptions()
      Parameters:
      privateDnsNameOptions - The options for the instance hostname.
      Returns:
      this

    • privateIpAddress

      @Stability(Stable) public CfnInstanceProps.Builder privateIpAddress(String privateIpAddress)
      Sets the value of CfnInstanceProps.getPrivateIpAddress()
      Parameters:
      privateIpAddress - 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.

      Returns:
      this

    • propagateTagsToVolumeOnCreation

      @Stability(Stable) public CfnInstanceProps.Builder propagateTagsToVolumeOnCreation(Boolean propagateTagsToVolumeOnCreation)
      Sets the value of CfnInstanceProps.getPropagateTagsToVolumeOnCreation()
      Parameters:
      propagateTagsToVolumeOnCreation - 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.
      Returns:
      this

    • propagateTagsToVolumeOnCreation

      @Stability(Stable) public CfnInstanceProps.Builder propagateTagsToVolumeOnCreation(IResolvable propagateTagsToVolumeOnCreation)
      Sets the value of CfnInstanceProps.getPropagateTagsToVolumeOnCreation()
      Parameters:
      propagateTagsToVolumeOnCreation - 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.
      Returns:
      this

    • ramdiskId

      @Stability(Stable) public CfnInstanceProps.Builder ramdiskId(String ramdiskId)
      Sets the value of CfnInstanceProps.getRamdiskId()
      Parameters:
      ramdiskId - 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 .

      Returns:
      this

    • securityGroupIds

      @Stability(Stable) public CfnInstanceProps.Builder securityGroupIds(List<String> securityGroupIds)
      Sets the value of CfnInstanceProps.getSecurityGroupIds()
      Parameters:
      securityGroupIds - 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.

      Returns:
      this

    • securityGroups

      @Stability(Stable) public CfnInstanceProps.Builder securityGroups(List<String> securityGroups)
      Sets the value of CfnInstanceProps.getSecurityGroups()
      Parameters:
      securityGroups - [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.

      Returns:
      this

    • sourceDestCheck

      @Stability(Stable) public CfnInstanceProps.Builder sourceDestCheck(Boolean sourceDestCheck)
      Sets the value of CfnInstanceProps.getSourceDestCheck()
      Parameters:
      sourceDestCheck - Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. 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.
      Returns:
      this

    • sourceDestCheck

      @Stability(Stable) public CfnInstanceProps.Builder sourceDestCheck(IResolvable sourceDestCheck)
      Sets the value of CfnInstanceProps.getSourceDestCheck()
      Parameters:
      sourceDestCheck - Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. 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.
      Returns:
      this

    • ssmAssociations

      @Stability(Stable) public CfnInstanceProps.Builder ssmAssociations(IResolvable ssmAssociations)
      Sets the value of CfnInstanceProps.getSsmAssociations()
      Parameters:
      ssmAssociations - The SSM document and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see Create an IAM instance profile for Systems Manager in the AWS Systems Manager User Guide .

      You can currently associate only one document with an instance.

      Returns:
      this

    • ssmAssociations

      @Stability(Stable) public CfnInstanceProps.Builder ssmAssociations(List<? extends Object> ssmAssociations)
      Sets the value of CfnInstanceProps.getSsmAssociations()
      Parameters:
      ssmAssociations - The SSM document and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see Create an IAM instance profile for Systems Manager in the AWS Systems Manager User Guide .

      You can currently associate only one document with an instance.

      Returns:
      this

    • subnetId

      @Stability(Stable) public CfnInstanceProps.Builder subnetId(String subnetId)
      Sets the value of CfnInstanceProps.getSubnetId()
      Parameters:
      subnetId - 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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnInstanceProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnInstanceProps.getTags()
      Parameters:
      tags - 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 .
      Returns:
      this

    • tenancy

      @Stability(Stable) public CfnInstanceProps.Builder tenancy(String tenancy)
      Sets the value of CfnInstanceProps.getTenancy()
      Parameters:
      tenancy - The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
      Returns:
      this

    • userData

      @Stability(Stable) public CfnInstanceProps.Builder userData(String userData)
      Sets the value of CfnInstanceProps.getUserData()
      Parameters:
      userData - The user data script to make available to the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see Fn::Base64 .

      User data runs only at instance launch. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch .

      Returns:
      this

    • volumes

      @Stability(Stable) public CfnInstanceProps.Builder volumes(IResolvable volumes)
      Sets the value of CfnInstanceProps.getVolumes()
      Parameters:
      volumes - The volumes to attach to the instance.
      Returns:
      this

    • volumes

      @Stability(Stable) public CfnInstanceProps.Builder volumes(List<? extends Object> volumes)
      Sets the value of CfnInstanceProps.getVolumes()
      Parameters:
      volumes - The volumes to attach to the instance.
      Returns:
      this

    • build

      @Stability(Stable) public CfnInstanceProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnInstanceProps>
      Returns:
      a new instance of CfnInstanceProps
      Throws:
      NullPointerException - if any required attribute was not provided