Class AwsEc2LaunchTemplateDataDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsEc2LaunchTemplateDataDetails.Builder,
AwsEc2LaunchTemplateDataDetails>
The information to include in an Amazon Elastic Compute Cloud (Amazon EC2) launch template.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionInformation about a block device mapping for an Amazon EC2 launch template.builder()
Specifies an instance's Capacity Reservation targeting option.Specifies the CPU options for an instance.Specifies the credit option for CPU usage of a T2, T3, or T3a instance.final Boolean
Indicates whether to enable the instance for stop protection.final Boolean
If you set this parameter totrue
, you can't terminate the instance using the Amazon EC2 console, CLI, or API.final Boolean
Indicates whether the instance is optimized for Amazon EBS I/O.Provides details about Elastic Graphics accelerators to associate with the instance.The Amazon Elastic Inference accelerator for the instance.Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BlockDeviceMappingSet property.final boolean
For responses, this returns true if the service returned a value for the ElasticGpuSpecificationSet property.final boolean
For responses, this returns true if the service returned a value for the ElasticInferenceAcceleratorSet property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LicenseSet property.final boolean
For responses, this returns true if the service returned a value for the NetworkInterfaceSet property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIdSet property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupSet property.Specifies whether your Amazon EC2 instance is configured for hibernation.The name or Amazon Resource Name (ARN) of an IAM instance profile.final String
imageId()
The ID of the Amazon Machine Image (AMI).final String
Provides the options for specifying the instance initiated shutdown behavior.Specifies the market (purchasing) option for an instance.The attributes for the instance types.final String
The instance type.final String
kernelId()
The ID of the kernel.final String
keyName()
The name of the key pair that allows users to connect to the instance.Specifies a license configuration for an instance.The maintenance options of your instance.The metadata options for the instance.The monitoring for the instance.Specifies the parameters for a network interface that is attached to the instance.Specifies the placement of an instance.The options for the instance hostname.final String
The ID of the RAM disk.One or more security group IDs.One or more security group names.static Class
<? extends AwsEc2LaunchTemplateDataDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userData()
The user data to make available to the instance.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasBlockDeviceMappingSet
public final boolean hasBlockDeviceMappingSet()For responses, this returns true if the service returned a value for the BlockDeviceMappingSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
blockDeviceMappingSet
Information about a block device mapping for an Amazon EC2 launch template.
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
hasBlockDeviceMappingSet()
method.- Returns:
- Information about a block device mapping for an Amazon EC2 launch template.
-
capacityReservationSpecification
public final AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails capacityReservationSpecification()Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
- Returns:
- Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
-
cpuOptions
Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.
- Returns:
- Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.
-
creditSpecification
Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
- Returns:
- Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
-
disableApiStop
Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.
- Returns:
- Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.
-
disableApiTermination
If you set this parameter to
true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set totrue
, you can.- Returns:
- If you set this parameter to
true
, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set totrue
, you can.
-
ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
- Returns:
- Indicates whether the instance is optimized for Amazon EBS I/O.
-
hasElasticGpuSpecificationSet
public final boolean hasElasticGpuSpecificationSet()For responses, this returns true if the service returned a value for the ElasticGpuSpecificationSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
elasticGpuSpecificationSet
public final List<AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails> elasticGpuSpecificationSet()Provides details about Elastic Graphics accelerators to associate with the instance.
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
hasElasticGpuSpecificationSet()
method.- Returns:
- Provides details about Elastic Graphics accelerators to associate with the instance.
-
hasElasticInferenceAcceleratorSet
public final boolean hasElasticInferenceAcceleratorSet()For responses, this returns true if the service returned a value for the ElasticInferenceAcceleratorSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
elasticInferenceAcceleratorSet
public final List<AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails> elasticInferenceAcceleratorSet()The Amazon Elastic Inference accelerator for the instance.
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
hasElasticInferenceAcceleratorSet()
method.- Returns:
- The Amazon Elastic Inference accelerator for the instance.
-
enclaveOptions
Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.
- Returns:
- Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.
-
hibernationOptions
Specifies whether your Amazon EC2 instance is configured for hibernation.
- Returns:
- Specifies whether your Amazon EC2 instance is configured for hibernation.
-
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.
-
imageId
The ID of the Amazon Machine Image (AMI).
- Returns:
- The ID of the Amazon Machine Image (AMI).
-
instanceInitiatedShutdownBehavior
Provides the options for specifying the instance initiated shutdown behavior.
- Returns:
- Provides the options for specifying the instance initiated shutdown behavior.
-
instanceMarketOptions
Specifies the market (purchasing) option for an instance.
- Returns:
- Specifies the market (purchasing) option for an instance.
-
instanceRequirements
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify
InstanceRequirements
, you can't specifyInstanceType
.- Returns:
- The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify
instance types with these attributes. If you specify
InstanceRequirements
, you can't specifyInstanceType
.
-
instanceType
The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify
InstanceType
, you can't specifyInstanceRequirements
.- Returns:
- The instance type. For more information, see Instance types in the
Amazon EC2 User Guide. If you specify
InstanceType
, you can't specifyInstanceRequirements
.
-
kernelId
The ID of the kernel.
- Returns:
- The ID of the kernel.
-
keyName
The name of the key pair that allows users to connect to the instance.
- Returns:
- The name of the key pair that allows users to connect to the instance.
-
hasLicenseSet
public final boolean hasLicenseSet()For responses, this returns true if the service returned a value for the LicenseSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
licenseSet
Specifies a license configuration for an instance.
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
hasLicenseSet()
method.- Returns:
- Specifies a license configuration for an instance.
-
maintenanceOptions
The maintenance options of your instance.
- Returns:
- The maintenance options of your instance.
-
metadataOptions
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
- Returns:
- The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
-
monitoring
The monitoring for the instance.
- Returns:
- The monitoring for the instance.
-
hasNetworkInterfaceSet
public final boolean hasNetworkInterfaceSet()For responses, this returns true if the service returned a value for the NetworkInterfaceSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
networkInterfaceSet
Specifies the parameters for a network interface that is attached to the instance.
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
hasNetworkInterfaceSet()
method.- Returns:
- Specifies the parameters for a network interface that is attached to the instance.
-
placement
Specifies the placement of an instance.
- Returns:
- Specifies the placement of an instance.
-
privateDnsNameOptions
The options for the instance hostname.
- Returns:
- The options for the instance hostname.
-
ramDiskId
The ID of the RAM disk.
- Returns:
- The ID of the RAM disk.
-
hasSecurityGroupIdSet
public final boolean hasSecurityGroupIdSet()For responses, this returns true if the service returned a value for the SecurityGroupIdSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
securityGroupIdSet
One or more security group IDs.
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
hasSecurityGroupIdSet()
method.- Returns:
- One or more security group IDs.
-
hasSecurityGroupSet
public final boolean hasSecurityGroupSet()For responses, this returns true if the service returned a value for the SecurityGroupSet property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
securityGroupSet
One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name 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
hasSecurityGroupSet()
method.- Returns:
- One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
-
userData
The user data to make available to the instance.
- Returns:
- The user data to make available to the instance.
-
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 interfaceToCopyableBuilder<AwsEc2LaunchTemplateDataDetails.Builder,
AwsEc2LaunchTemplateDataDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-