@Generated(value="software.amazon.awssdk:codegen") public class JobFlowDetail extends Object implements StructuredPojo, ToCopyableBuilder<JobFlowDetail.Builder,JobFlowDetail>
A description of a cluster (job flow).
Modifier and Type | Class and Description |
---|---|
static interface |
JobFlowDetail.Builder |
Modifier and Type | Method and Description |
---|---|
String |
amiVersion()
Used only for version 2.x and 3.x of Amazon EMR.
|
String |
autoScalingRole()
An IAM role for automatic scaling policies.
|
List<BootstrapActionDetail> |
bootstrapActions()
A list of the bootstrap actions run by the job flow.
|
static JobFlowDetail.Builder |
builder() |
boolean |
equals(Object obj) |
JobFlowExecutionStatusDetail |
executionStatusDetail()
Describes the execution status of the job flow.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
JobFlowInstancesDetail |
instances()
Describes the Amazon EC2 instances of the job flow.
|
String |
jobFlowId()
The job flow identifier.
|
String |
jobFlowRole()
The IAM role that was specified when the job flow was launched.
|
String |
logUri()
The location in Amazon S3 where log files for the job are stored.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
name()
The name of the job flow.
|
ScaleDownBehavior |
scaleDownBehavior()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized.
|
String |
scaleDownBehaviorString()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized.
|
static Class<? extends JobFlowDetail.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
|
List<StepDetail> |
steps()
A list of steps run by the job flow.
|
List<String> |
supportedProducts()
A list of strings set by third party software when the job flow is launched.
|
JobFlowDetail.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
visibleToAllUsers()
Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster.
|
copy
public String jobFlowId()
The job flow identifier.
public String name()
The name of the job flow.
public String logUri()
The location in Amazon S3 where log files for the job are stored.
public String amiVersion()
Used only for version 2.x and 3.x of Amazon EMR. The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide.
public JobFlowExecutionStatusDetail executionStatusDetail()
Describes the execution status of the job flow.
public JobFlowInstancesDetail instances()
Describes the Amazon EC2 instances of the job flow.
public List<StepDetail> steps()
A list of steps run by the job flow.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<BootstrapActionDetail> bootstrapActions()
A list of the bootstrap actions run by the job flow.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> supportedProducts()
A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean visibleToAllUsers()
Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this
value is set to true
, all IAM users of that AWS account can view and (if they have the proper policy
permissions set) manage the cluster. If it is set to false
, only the IAM user that created the
cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.
true
, all IAM users of that AWS account can view and (if they have
the proper policy permissions set) manage the cluster. If it is set to false
, only the IAM
user that created the cluster can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.public String jobFlowRole()
The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.
public String serviceRole()
The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
public String autoScalingRole()
An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole
. The IAM
role provides a way for the automatic scaling feature to get the required permissions it needs to launch and
terminate EC2 instances in an instance group.
EMR_AutoScaling_DefaultRole
.
The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to
launch and terminate EC2 instances in an instance group.public ScaleDownBehavior scaleDownBehavior()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the
instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR blacklists and drains tasks from nodes before
terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.
TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the
default for versions of Amazon EMR earlier than 5.1.0.
If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior
will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from scaleDownBehaviorString()
.
TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates
nodes at the instance-hour boundary, regardless of when the request to terminate the instance was
submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters
created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR
blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the
instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks
instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR
earlier than 5.1.0.ScaleDownBehavior
public String scaleDownBehaviorString()
The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
group is resized. TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates nodes at the
instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR blacklists and drains tasks from nodes before
terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.
TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the
default for versions of Amazon EMR earlier than 5.1.0.
If the service returns an enum value that is not available in the current SDK version, scaleDownBehavior
will return ScaleDownBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from scaleDownBehaviorString()
.
TERMINATE_AT_INSTANCE_HOUR
indicates that Amazon EMR terminates
nodes at the instance-hour boundary, regardless of when the request to terminate the instance was
submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters
created using that version. TERMINATE_AT_TASK_COMPLETION
indicates that Amazon EMR
blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the
instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks
instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION
available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR
earlier than 5.1.0.ScaleDownBehavior
public JobFlowDetail.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<JobFlowDetail.Builder,JobFlowDetail>
public static JobFlowDetail.Builder builder()
public static Class<? extends JobFlowDetail.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.