software.amazon.awssdk.services.emr.model

Class Ec2InstanceAttributes

java.lang.Object

software.amazon.awssdk.services.emr.model.Ec2InstanceAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Ec2InstanceAttributes.Builder,Ec2InstanceAttributes>

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

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Ec2InstanceAttributes.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	additionalMasterSecurityGroups() A list of additional Amazon EC2 security group IDs for the master node.
List<String>	additionalSlaveSecurityGroups() A list of additional Amazon EC2 security group IDs for the core and task nodes.
static Ec2InstanceAttributes.Builder	builder()
String	ec2AvailabilityZone() The Availability Zone in which the cluster will run.
String	ec2KeyName() The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".
String	ec2SubnetId() Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch.
String	emrManagedMasterSecurityGroup() The identifier of the Amazon EC2 security group for the master node.
String	emrManagedSlaveSecurityGroup() The identifier of the Amazon EC2 security group for the core and task nodes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalMasterSecurityGroups() Returns true if the AdditionalMasterSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAdditionalSlaveSecurityGroups() Returns true if the AdditionalSlaveSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasRequestedEc2AvailabilityZones() Returns true if the RequestedEc2AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRequestedEc2SubnetIds() Returns true if the RequestedEc2SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamInstanceProfile() The IAM role that was specified when the cluster was launched.
List<String>	requestedEc2AvailabilityZones() Applies to clusters configured with the instance fleets option.
List<String>	requestedEc2SubnetIds() Applies to clusters configured with the instance fleets option.
List<SdkField<?>>	sdkFields()
static Class<? extends Ec2InstanceAttributes.Builder>	serializableBuilderClass()
String	serviceAccessSecurityGroup() The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.
Ec2InstanceAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

ec2KeyName

public String ec2KeyName()

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".

Returns:

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named "hadoop".

ec2SubnetId

public String ec2SubnetId()

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Returns:

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

hasRequestedEc2SubnetIds

public boolean hasRequestedEc2SubnetIds()

Returns true if the RequestedEc2SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

requestedEc2SubnetIds

public List<String> requestedEc2SubnetIds()

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

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

You can use hasRequestedEc2SubnetIds() to see if a value was sent in this field.

Returns:

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

ec2AvailabilityZone

public String ec2AvailabilityZone()

The Availability Zone in which the cluster will run.

Returns:

The Availability Zone in which the cluster will run.

hasRequestedEc2AvailabilityZones

public boolean hasRequestedEc2AvailabilityZones()

Returns true if the RequestedEc2AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

requestedEc2AvailabilityZones

public List<String> requestedEc2AvailabilityZones()

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

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

You can use hasRequestedEc2AvailabilityZones() to see if a value was sent in this field.

Returns:

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

iamInstanceProfile

public String iamInstanceProfile()

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

Returns:

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

emrManagedMasterSecurityGroup

public String emrManagedMasterSecurityGroup()

The identifier of the Amazon EC2 security group for the master node.

Returns:

The identifier of the Amazon EC2 security group for the master node.

emrManagedSlaveSecurityGroup

public String emrManagedSlaveSecurityGroup()

The identifier of the Amazon EC2 security group for the core and task nodes.

Returns:

The identifier of the Amazon EC2 security group for the core and task nodes.

serviceAccessSecurityGroup

public String serviceAccessSecurityGroup()

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

Returns:

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

hasAdditionalMasterSecurityGroups

public boolean hasAdditionalMasterSecurityGroups()

Returns true if the AdditionalMasterSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalMasterSecurityGroups

public List<String> additionalMasterSecurityGroups()

A list of additional Amazon EC2 security group IDs for the master node.

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

You can use hasAdditionalMasterSecurityGroups() to see if a value was sent in this field.

Returns:

A list of additional Amazon EC2 security group IDs for the master node.

hasAdditionalSlaveSecurityGroups

public boolean hasAdditionalSlaveSecurityGroups()

Returns true if the AdditionalSlaveSecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalSlaveSecurityGroups

public List<String> additionalSlaveSecurityGroups()

A list of additional Amazon EC2 security group IDs for the core and task nodes.

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

You can use hasAdditionalSlaveSecurityGroups() to see if a value was sent in this field.

Returns:

A list of additional Amazon EC2 security group IDs for the core and task nodes.

toBuilder

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

Returns:

a builder for type T

builder

public static Ec2InstanceAttributes.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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