Class LaunchSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.LaunchSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>
@Generated("software.amazon.awssdk:codegen") public final class LaunchSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>
Describes the launch specification for an instance.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
LaunchSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
addressingType()
Deprecated.List<BlockDeviceMapping>
blockDeviceMappings()
The block device mapping entries.static LaunchSpecification.Builder
builder()
Boolean
ebsOptimized()
Indicates whether the instance is optimized for EBS I/O.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasBlockDeviceMappings()
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.int
hashCode()
boolean
hasNetworkInterfaces()
For responses, this returns true if the service returned a value for the NetworkInterfaces property.boolean
hasSecurityGroups()
For responses, this returns true if the service returned a value for the SecurityGroups property.IamInstanceProfileSpecification
iamInstanceProfile()
The IAM instance profile.String
imageId()
The ID of the AMI.InstanceType
instanceType()
The instance type.String
instanceTypeAsString()
The instance type.String
kernelId()
The ID of the kernel.String
keyName()
The name of the key pair.RunInstancesMonitoringEnabled
monitoring()
Returns the value of the Monitoring property for this object.List<InstanceNetworkInterfaceSpecification>
networkInterfaces()
The network interfaces.SpotPlacement
placement()
The placement information for the instance.String
ramdiskId()
The ID of the RAM disk.List<SdkField<?>>
sdkFields()
List<GroupIdentifier>
securityGroups()
The IDs of the security groups.static Class<? extends LaunchSpecification.Builder>
serializableBuilderClass()
String
subnetId()
The ID of the subnet in which to launch the instance.LaunchSpecification.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
userData()
The base64-encoded user data that instances use when starting up.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
userData
public final String userData()
The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
- Returns:
- The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
-
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 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.
-
securityGroups
public final List<GroupIdentifier> securityGroups()
The IDs of the security groups.
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:
- The IDs of the security groups.
-
addressingType
public final String addressingType()
Deprecated.
- Returns:
- Deprecated.
-
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 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.
-
blockDeviceMappings
public final List<BlockDeviceMapping> blockDeviceMappings()
The block device mapping entries.
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 entries.
-
ebsOptimized
public final Boolean ebsOptimized()
Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal 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 EBS I/O. This optimization provides dedicated throughput
to Amazon EBS and an optimized configuration stack to provide optimal 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 IAM instance profile.
- Returns:
- The IAM instance profile.
-
imageId
public final String imageId()
The ID of the AMI.
- Returns:
- The ID of the AMI.
-
instanceType
public final InstanceType instanceType()
The instance type. Only one instance type can be specified.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type. Only one instance type can be specified.
- See Also:
InstanceType
-
instanceTypeAsString
public final String instanceTypeAsString()
The instance type. Only one instance type can be specified.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type. Only one instance type can be specified.
- See Also:
InstanceType
-
kernelId
public final String kernelId()
The ID of the kernel.
- Returns:
- The ID of the kernel.
-
keyName
public final String keyName()
The name of the key pair.
- Returns:
- The name of the key pair.
-
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 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.
-
networkInterfaces
public final List<InstanceNetworkInterfaceSpecification> networkInterfaces()
The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using 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. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
-
placement
public final SpotPlacement placement()
The placement information for the instance.
- Returns:
- The placement information for the instance.
-
ramdiskId
public final String ramdiskId()
The ID of the RAM disk.
- Returns:
- The ID of the RAM disk.
-
subnetId
public final String subnetId()
The ID of the subnet in which to launch the instance.
- Returns:
- The ID of the subnet in which to launch the instance.
-
monitoring
public final RunInstancesMonitoringEnabled monitoring()
Returns the value of the Monitoring property for this object.- Returns:
- The value of the Monitoring property for this object.
-
toBuilder
public LaunchSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>
-
builder
public static LaunchSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends LaunchSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-