software.amazon.awssdk.services.ec2.model

Class LaunchSpecification

java.lang.Object

software.amazon.awssdk.services.ec2.model.LaunchSpecification

All Implemented Interfaces:

ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public final class LaunchSpecification
extends Object
implements ToCopyableBuilder<LaunchSpecification.Builder,LaunchSpecification>

Describes the launch specification for an instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LaunchSpecification.Builder

Method Summary

Modifier and Type	Method and Description
String	addressingType() Deprecated.
List<GroupIdentifier>	allSecurityGroups() One or more security groups.
List<BlockDeviceMapping>	blockDeviceMappings() One or more block device mapping entries.
static LaunchSpecification.Builder	builder()
Boolean	ebsOptimized() Indicates whether the instance is optimized for EBS I/O.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Boolean	monitoringEnabled() Returns the value of the MonitoringEnabled property for this object.
List<InstanceNetworkInterfaceSpecification>	networkInterfaces() One or more network interfaces.
SpotPlacement	placement() The placement information for the instance.
String	ramdiskId() The ID of the RAM disk.
List<String>	securityGroups() One or more security group names.
static Class<? extends LaunchSpecification.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet in which to launch the instance.
LaunchSpecification.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userData() The user data to make available to the instances.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userData

public String userData()

The user data to make available to the instances. If you are using an AWS SDK or 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.

Returns:

The user data to make available to the instances. If you are using an AWS SDK or 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.

addressingType

public String addressingType()

Deprecated.

Returns:

Deprecated.

blockDeviceMappings

public List<BlockDeviceMapping> blockDeviceMappings()

One or more block device mapping entries.

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

Returns:

One or more block device mapping entries.

ebsOptimized

public 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 IamInstanceProfileSpecification iamInstanceProfile()

The IAM instance profile.

Returns:

The IAM instance profile.

imageId

public String imageId()

The ID of the AMI.

Returns:

The ID of the AMI.

instanceType

public InstanceType instanceType()

The instance type.

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.

See Also:

InstanceType

instanceTypeAsString

public String instanceTypeAsString()

The instance type.

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.

See Also:

InstanceType

kernelId

public String kernelId()

The ID of the kernel.

Returns:

The ID of the kernel.

keyName

public String keyName()

The name of the key pair.

Returns:

The name of the key pair.

networkInterfaces

public List<InstanceNetworkInterfaceSpecification> networkInterfaces()

One or more 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.

Returns:

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

placement

public SpotPlacement placement()

The placement information for the instance.

Returns:

The placement information for the instance.

ramdiskId

public String ramdiskId()

The ID of the RAM disk.

Returns:

The ID of the RAM disk.

subnetId

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

allSecurityGroups

public List<GroupIdentifier> allSecurityGroups()

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

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

Returns:

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

monitoringEnabled

public Boolean monitoringEnabled()

Returns the value of the MonitoringEnabled property for this object.

Returns:

The value of the MonitoringEnabled property for this object.

securityGroups

public List<String> securityGroups()

One or more security group names.

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

Returns:

One or more security group names.

toBuilder

public LaunchSpecification.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<LaunchSpecification.Builder,LaunchSpecification>

Returns:

a builder for type T

builder

public static LaunchSpecification.Builder builder()

serializableBuilderClass

public static Class<? extends LaunchSpecification.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)