Class RunInstancesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RunInstancesRequest.Builder,RunInstancesRequest>

@Generated("software.amazon.awssdk:codegen") public final class RunInstancesRequest extends Ec2Request implements ToCopyableBuilder<RunInstancesRequest.Builder,RunInstancesRequest>
  • Method Details

    • hasBlockDeviceMappings

      public final boolean hasBlockDeviceMappings()
      For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • blockDeviceMappings

      public final List<BlockDeviceMapping> blockDeviceMappings()

      The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.

      Returns:
      The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.
    • imageId

      public final String 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:
      The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
    • instanceType

      public final InstanceType instanceType()

      The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
      See Also:
    • instanceTypeAsString

      public final String instanceTypeAsString()

      The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
      See Also:
    • ipv6AddressCount

      public final Integer 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:
      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.

    • hasIpv6Addresses

      public final boolean hasIpv6Addresses()
      For responses, this returns true if the service returned a value for the Ipv6Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • ipv6Addresses

      public final List<InstanceIpv6Address> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv6Addresses() method.

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

    • kernelId

      public final String 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:
      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.

    • keyName

      public final String 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:
      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.

    • maxCount

      public final Integer maxCount()

      The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

      Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

      Returns:
      The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

      Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

    • minCount

      public final Integer minCount()

      The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

      Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

      Returns:
      The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

      Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

    • monitoring

      public final RunInstancesMonitoringEnabled monitoring()

      Specifies whether detailed monitoring is enabled for the instance.

      Returns:
      Specifies whether detailed monitoring is enabled for the instance.
    • placement

      public final Placement placement()

      The placement for the instance.

      Returns:
      The placement for the instance.
    • ramdiskId

      public final String 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 Amazon Web Services 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:
      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 Amazon Web Services 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.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • securityGroupIds

      public final List<String> securityGroupIds()

      The IDs of the security groups. You can create a security group using CreateSecurityGroup.

      If you specify a network interface, you must specify any security groups as part of the network interface.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      The IDs of the security groups. You can create a security group using CreateSecurityGroup.

      If you specify a network interface, you must specify any security groups as part of the network interface.

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • securityGroups

      public final List<String> securityGroups()

      [Default VPC] The names of the security groups.

      If you specify a network interface, you must specify any security groups as part of the network interface.

      Default: Amazon EC2 uses the default security group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

      Returns:
      [Default VPC] The names of the security groups.

      If you specify a network interface, you must specify any security groups as part of the network interface.

      Default: Amazon EC2 uses the default security group.

    • subnetId

      public final String 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:
      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.

    • userData

      public final String userData()

      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.

      Returns:
      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.
    • additionalInfo

      public final String additionalInfo()

      Reserved.

      Returns:
      Reserved.
    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

      For more information, see Ensuring Idempotency.

      Constraints: Maximum 64 ASCII characters

      Returns:
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

      For more information, see Ensuring Idempotency.

      Constraints: Maximum 64 ASCII characters

    • disableApiTermination

      public final Boolean 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:
      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

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    • ebsOptimized

      public final Boolean 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:
      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

    • iamInstanceProfile

      public final IamInstanceProfileSpecification iamInstanceProfile()

      The name or Amazon Resource Name (ARN) of an IAM instance profile.

      Returns:
      The name or Amazon Resource Name (ARN) of an IAM instance profile.
    • instanceInitiatedShutdownBehavior

      public final ShutdownBehavior 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

      If the service returns an enum value that is not available in the current SDK version, instanceInitiatedShutdownBehavior will return ShutdownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceInitiatedShutdownBehaviorAsString().

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

      Default: stop

      See Also:
    • instanceInitiatedShutdownBehaviorAsString

      public final String instanceInitiatedShutdownBehaviorAsString()

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

      Default: stop

      If the service returns an enum value that is not available in the current SDK version, instanceInitiatedShutdownBehavior will return ShutdownBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceInitiatedShutdownBehaviorAsString().

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

      Default: stop

      See Also:
    • hasNetworkInterfaces

      public final boolean hasNetworkInterfaces()
      For responses, this returns true if the service returned a value for the NetworkInterfaces property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • networkInterfaces

      public final List<InstanceNetworkInterfaceSpecification> networkInterfaces()

      The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfaces() method.

      Returns:
      The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
    • privateIpAddress

      public final String 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.

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

    • hasElasticGpuSpecification

      public final boolean hasElasticGpuSpecification()
      For responses, this returns true if the service returned a value for the ElasticGpuSpecification property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • elasticGpuSpecification

      public final List<ElasticGpuSpecification> elasticGpuSpecification()

      Deprecated.

      Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasElasticGpuSpecification() method.

      Returns:
      Deprecated.

      Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

    • hasElasticInferenceAccelerators

      public final boolean hasElasticInferenceAccelerators()
      For responses, this returns true if the service returned a value for the ElasticInferenceAccelerators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • elasticInferenceAccelerators

      public final List<ElasticInferenceAccelerator> 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, Amazon Web Services 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasElasticInferenceAccelerators() method.

      Returns:
      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, Amazon Web Services 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.

    • hasTagSpecifications

      public final boolean hasTagSpecifications()
      For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the resources that are created during instance launch.

      You can specify tags for the following resources only:

      • Instances

      • Volumes

      • Spot Instance requests

      • Network interfaces

      To tag a resource after it has been created, see CreateTags.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

      Returns:
      The tags to apply to the resources that are created during instance launch.

      You can specify tags for the following resources only:

      • Instances

      • Volumes

      • Spot Instance requests

      • Network interfaces

      To tag a resource after it has been created, see CreateTags.

    • launchTemplate

      public final LaunchTemplateSpecification launchTemplate()

      The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

      Returns:
      The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
    • instanceMarketOptions

      public final InstanceMarketOptionsRequest instanceMarketOptions()

      The market (purchasing) option for the instances.

      For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

      Returns:
      The market (purchasing) option for the instances.

      For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

    • creditSpecification

      public final CreditSpecificationRequest 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:
      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.

    • cpuOptions

      public final CpuOptionsRequest cpuOptions()

      The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.

      Returns:
      The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
    • capacityReservationSpecification

      public final CapacityReservationSpecification capacityReservationSpecification()

      Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

      Returns:
      Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
    • hibernationOptions

      public final HibernationOptionsRequest hibernationOptions()

      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 instance in the Amazon EC2 User Guide.

      You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

      Returns:
      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 instance in the Amazon EC2 User Guide.

      You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

    • hasLicenseSpecifications

      public final boolean hasLicenseSpecifications()
      For responses, this returns true if the service returned a value for the LicenseSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • licenseSpecifications

      public final List<LicenseConfigurationRequest> licenseSpecifications()

      The license configurations.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLicenseSpecifications() method.

      Returns:
      The license configurations.
    • metadataOptions

      public final InstanceMetadataOptionsRequest metadataOptions()

      The metadata options for the instance. For more information, see Instance metadata and user data.

      Returns:
      The metadata options for the instance. For more information, see Instance metadata and user data.
    • enclaveOptions

      public final EnclaveOptionsRequest enclaveOptions()

      Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

      You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

      Returns:
      Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

      You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

    • privateDnsNameOptions

      public final PrivateDnsNameOptionsRequest privateDnsNameOptions()

      The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.

      Returns:
      The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.
    • maintenanceOptions

      public final InstanceMaintenanceOptionsRequest maintenanceOptions()

      The maintenance and recovery options for the instance.

      Returns:
      The maintenance and recovery options for the instance.
    • disableApiStop

      public final Boolean disableApiStop()

      Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.

      Returns:
      Indicates whether an instance is enabled for stop protection. For more information, see Stop protection.
    • enablePrimaryIpv6

      public final Boolean enablePrimaryIpv6()

      If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.

      Returns:
      If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
    • toBuilder

      public RunInstancesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RunInstancesRequest.Builder,RunInstancesRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T
    • builder

      public static RunInstancesRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends RunInstancesRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.