AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::EMR::Model::JobFlowDetail Class Reference

#include <JobFlowDetail.h>

Public Member Functions

 JobFlowDetail ()
 
 JobFlowDetail (Aws::Utils::Json::JsonView jsonValue)
 
JobFlowDetailoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobFlowId () const
 
bool JobFlowIdHasBeenSet () const
 
void SetJobFlowId (const Aws::String &value)
 
void SetJobFlowId (Aws::String &&value)
 
void SetJobFlowId (const char *value)
 
JobFlowDetailWithJobFlowId (const Aws::String &value)
 
JobFlowDetailWithJobFlowId (Aws::String &&value)
 
JobFlowDetailWithJobFlowId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
JobFlowDetailWithName (const Aws::String &value)
 
JobFlowDetailWithName (Aws::String &&value)
 
JobFlowDetailWithName (const char *value)
 
const Aws::StringGetLogUri () const
 
bool LogUriHasBeenSet () const
 
void SetLogUri (const Aws::String &value)
 
void SetLogUri (Aws::String &&value)
 
void SetLogUri (const char *value)
 
JobFlowDetailWithLogUri (const Aws::String &value)
 
JobFlowDetailWithLogUri (Aws::String &&value)
 
JobFlowDetailWithLogUri (const char *value)
 
const Aws::StringGetLogEncryptionKmsKeyId () const
 
bool LogEncryptionKmsKeyIdHasBeenSet () const
 
void SetLogEncryptionKmsKeyId (const Aws::String &value)
 
void SetLogEncryptionKmsKeyId (Aws::String &&value)
 
void SetLogEncryptionKmsKeyId (const char *value)
 
JobFlowDetailWithLogEncryptionKmsKeyId (const Aws::String &value)
 
JobFlowDetailWithLogEncryptionKmsKeyId (Aws::String &&value)
 
JobFlowDetailWithLogEncryptionKmsKeyId (const char *value)
 
const Aws::StringGetAmiVersion () const
 
bool AmiVersionHasBeenSet () const
 
void SetAmiVersion (const Aws::String &value)
 
void SetAmiVersion (Aws::String &&value)
 
void SetAmiVersion (const char *value)
 
JobFlowDetailWithAmiVersion (const Aws::String &value)
 
JobFlowDetailWithAmiVersion (Aws::String &&value)
 
JobFlowDetailWithAmiVersion (const char *value)
 
const JobFlowExecutionStatusDetailGetExecutionStatusDetail () const
 
bool ExecutionStatusDetailHasBeenSet () const
 
void SetExecutionStatusDetail (const JobFlowExecutionStatusDetail &value)
 
void SetExecutionStatusDetail (JobFlowExecutionStatusDetail &&value)
 
JobFlowDetailWithExecutionStatusDetail (const JobFlowExecutionStatusDetail &value)
 
JobFlowDetailWithExecutionStatusDetail (JobFlowExecutionStatusDetail &&value)
 
const JobFlowInstancesDetailGetInstances () const
 
bool InstancesHasBeenSet () const
 
void SetInstances (const JobFlowInstancesDetail &value)
 
void SetInstances (JobFlowInstancesDetail &&value)
 
JobFlowDetailWithInstances (const JobFlowInstancesDetail &value)
 
JobFlowDetailWithInstances (JobFlowInstancesDetail &&value)
 
const Aws::Vector< StepDetail > & GetSteps () const
 
bool StepsHasBeenSet () const
 
void SetSteps (const Aws::Vector< StepDetail > &value)
 
void SetSteps (Aws::Vector< StepDetail > &&value)
 
JobFlowDetailWithSteps (const Aws::Vector< StepDetail > &value)
 
JobFlowDetailWithSteps (Aws::Vector< StepDetail > &&value)
 
JobFlowDetailAddSteps (const StepDetail &value)
 
JobFlowDetailAddSteps (StepDetail &&value)
 
const Aws::Vector< BootstrapActionDetail > & GetBootstrapActions () const
 
bool BootstrapActionsHasBeenSet () const
 
void SetBootstrapActions (const Aws::Vector< BootstrapActionDetail > &value)
 
void SetBootstrapActions (Aws::Vector< BootstrapActionDetail > &&value)
 
JobFlowDetailWithBootstrapActions (const Aws::Vector< BootstrapActionDetail > &value)
 
JobFlowDetailWithBootstrapActions (Aws::Vector< BootstrapActionDetail > &&value)
 
JobFlowDetailAddBootstrapActions (const BootstrapActionDetail &value)
 
JobFlowDetailAddBootstrapActions (BootstrapActionDetail &&value)
 
const Aws::Vector< Aws::String > & GetSupportedProducts () const
 
bool SupportedProductsHasBeenSet () const
 
void SetSupportedProducts (const Aws::Vector< Aws::String > &value)
 
void SetSupportedProducts (Aws::Vector< Aws::String > &&value)
 
JobFlowDetailWithSupportedProducts (const Aws::Vector< Aws::String > &value)
 
JobFlowDetailWithSupportedProducts (Aws::Vector< Aws::String > &&value)
 
JobFlowDetailAddSupportedProducts (const Aws::String &value)
 
JobFlowDetailAddSupportedProducts (Aws::String &&value)
 
JobFlowDetailAddSupportedProducts (const char *value)
 
bool GetVisibleToAllUsers () const
 
bool VisibleToAllUsersHasBeenSet () const
 
void SetVisibleToAllUsers (bool value)
 
JobFlowDetailWithVisibleToAllUsers (bool value)
 
const Aws::StringGetJobFlowRole () const
 
bool JobFlowRoleHasBeenSet () const
 
void SetJobFlowRole (const Aws::String &value)
 
void SetJobFlowRole (Aws::String &&value)
 
void SetJobFlowRole (const char *value)
 
JobFlowDetailWithJobFlowRole (const Aws::String &value)
 
JobFlowDetailWithJobFlowRole (Aws::String &&value)
 
JobFlowDetailWithJobFlowRole (const char *value)
 
const Aws::StringGetServiceRole () const
 
bool ServiceRoleHasBeenSet () const
 
void SetServiceRole (const Aws::String &value)
 
void SetServiceRole (Aws::String &&value)
 
void SetServiceRole (const char *value)
 
JobFlowDetailWithServiceRole (const Aws::String &value)
 
JobFlowDetailWithServiceRole (Aws::String &&value)
 
JobFlowDetailWithServiceRole (const char *value)
 
const Aws::StringGetAutoScalingRole () const
 
bool AutoScalingRoleHasBeenSet () const
 
void SetAutoScalingRole (const Aws::String &value)
 
void SetAutoScalingRole (Aws::String &&value)
 
void SetAutoScalingRole (const char *value)
 
JobFlowDetailWithAutoScalingRole (const Aws::String &value)
 
JobFlowDetailWithAutoScalingRole (Aws::String &&value)
 
JobFlowDetailWithAutoScalingRole (const char *value)
 
const ScaleDownBehaviorGetScaleDownBehavior () const
 
bool ScaleDownBehaviorHasBeenSet () const
 
void SetScaleDownBehavior (const ScaleDownBehavior &value)
 
void SetScaleDownBehavior (ScaleDownBehavior &&value)
 
JobFlowDetailWithScaleDownBehavior (const ScaleDownBehavior &value)
 
JobFlowDetailWithScaleDownBehavior (ScaleDownBehavior &&value)
 

Detailed Description

A description of a cluster (job flow).

See Also:

AWS API Reference

Definition at line 37 of file JobFlowDetail.h.

Constructor & Destructor Documentation

◆ JobFlowDetail() [1/2]

Aws::EMR::Model::JobFlowDetail::JobFlowDetail ( )

◆ JobFlowDetail() [2/2]

Aws::EMR::Model::JobFlowDetail::JobFlowDetail ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddBootstrapActions() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddBootstrapActions ( BootstrapActionDetail &&  value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 416 of file JobFlowDetail.h.

◆ AddBootstrapActions() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddBootstrapActions ( const BootstrapActionDetail value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 411 of file JobFlowDetail.h.

◆ AddSteps() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddSteps ( const StepDetail value)
inline

A list of steps run by the job flow.

Definition at line 370 of file JobFlowDetail.h.

◆ AddSteps() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddSteps ( StepDetail &&  value)
inline

A list of steps run by the job flow.

Definition at line 375 of file JobFlowDetail.h.

◆ AddSupportedProducts() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddSupportedProducts ( Aws::String &&  value)
inline

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.

Definition at line 473 of file JobFlowDetail.h.

◆ AddSupportedProducts() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddSupportedProducts ( const Aws::String value)
inline

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.

Definition at line 466 of file JobFlowDetail.h.

◆ AddSupportedProducts() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::AddSupportedProducts ( const char *  value)
inline

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.

Definition at line 480 of file JobFlowDetail.h.

◆ AmiVersionHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::AmiVersionHasBeenSet ( ) const
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 230 of file JobFlowDetail.h.

◆ AutoScalingRoleHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::AutoScalingRoleHasBeenSet ( ) const
inline

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.

Definition at line 680 of file JobFlowDetail.h.

◆ BootstrapActionsHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::BootstrapActionsHasBeenSet ( ) const
inline

A list of the bootstrap actions run by the job flow.

Definition at line 386 of file JobFlowDetail.h.

◆ ExecutionStatusDetailHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::ExecutionStatusDetailHasBeenSet ( ) const
inline

Describes the execution status of the job flow.

Definition at line 283 of file JobFlowDetail.h.

◆ GetAmiVersion()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetAmiVersion ( ) const
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 223 of file JobFlowDetail.h.

◆ GetAutoScalingRole()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetAutoScalingRole ( ) const
inline

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.

Definition at line 672 of file JobFlowDetail.h.

◆ GetBootstrapActions()

const Aws::Vector<BootstrapActionDetail>& Aws::EMR::Model::JobFlowDetail::GetBootstrapActions ( ) const
inline

A list of the bootstrap actions run by the job flow.

Definition at line 381 of file JobFlowDetail.h.

◆ GetExecutionStatusDetail()

const JobFlowExecutionStatusDetail& Aws::EMR::Model::JobFlowDetail::GetExecutionStatusDetail ( ) const
inline

Describes the execution status of the job flow.

Definition at line 278 of file JobFlowDetail.h.

◆ GetInstances()

const JobFlowInstancesDetail& Aws::EMR::Model::JobFlowDetail::GetInstances ( ) const
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 309 of file JobFlowDetail.h.

◆ GetJobFlowId()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetJobFlowId ( ) const
inline

The job flow identifier.

Definition at line 49 of file JobFlowDetail.h.

◆ GetJobFlowRole()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetJobFlowRole ( ) const
inline

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

Definition at line 572 of file JobFlowDetail.h.

◆ GetLogEncryptionKmsKeyId()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetLogEncryptionKmsKeyId ( ) const
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 173 of file JobFlowDetail.h.

◆ GetLogUri()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetLogUri ( ) const
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 131 of file JobFlowDetail.h.

◆ GetName()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetName ( ) const
inline

The name of the job flow.

Definition at line 90 of file JobFlowDetail.h.

◆ GetScaleDownBehavior()

const ScaleDownBehavior& Aws::EMR::Model::JobFlowDetail::GetScaleDownBehavior ( ) const
inline

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 adds nodes to a deny list 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.

Definition at line 746 of file JobFlowDetail.h.

◆ GetServiceRole()

const Aws::String& Aws::EMR::Model::JobFlowDetail::GetServiceRole ( ) const
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 621 of file JobFlowDetail.h.

◆ GetSteps()

const Aws::Vector<StepDetail>& Aws::EMR::Model::JobFlowDetail::GetSteps ( ) const
inline

A list of steps run by the job flow.

Definition at line 340 of file JobFlowDetail.h.

◆ GetSupportedProducts()

const Aws::Vector<Aws::String>& Aws::EMR::Model::JobFlowDetail::GetSupportedProducts ( ) const
inline

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.

Definition at line 424 of file JobFlowDetail.h.

◆ GetVisibleToAllUsers()

bool Aws::EMR::Model::JobFlowDetail::GetVisibleToAllUsers ( ) const
inline

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is true if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Definition at line 502 of file JobFlowDetail.h.

◆ InstancesHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::InstancesHasBeenSet ( ) const
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 314 of file JobFlowDetail.h.

◆ JobFlowIdHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::JobFlowIdHasBeenSet ( ) const
inline

The job flow identifier.

Definition at line 54 of file JobFlowDetail.h.

◆ JobFlowRoleHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::JobFlowRoleHasBeenSet ( ) const
inline

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

Definition at line 578 of file JobFlowDetail.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EMR::Model::JobFlowDetail::Jsonize ( ) const

◆ LogEncryptionKmsKeyIdHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::LogEncryptionKmsKeyIdHasBeenSet ( ) const
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 179 of file JobFlowDetail.h.

◆ LogUriHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::LogUriHasBeenSet ( ) const
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 136 of file JobFlowDetail.h.

◆ NameHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::NameHasBeenSet ( ) const
inline

The name of the job flow.

Definition at line 95 of file JobFlowDetail.h.

◆ operator=()

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ScaleDownBehaviorHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::ScaleDownBehaviorHasBeenSet ( ) const
inline

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 adds nodes to a deny list 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.

Definition at line 763 of file JobFlowDetail.h.

◆ ServiceRoleHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::ServiceRoleHasBeenSet ( ) const
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 627 of file JobFlowDetail.h.

◆ SetAmiVersion() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetAmiVersion ( Aws::String &&  value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 244 of file JobFlowDetail.h.

◆ SetAmiVersion() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetAmiVersion ( const Aws::String value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 237 of file JobFlowDetail.h.

◆ SetAmiVersion() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetAmiVersion ( const char *  value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 251 of file JobFlowDetail.h.

◆ SetAutoScalingRole() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetAutoScalingRole ( Aws::String &&  value)
inline

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.

Definition at line 696 of file JobFlowDetail.h.

◆ SetAutoScalingRole() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetAutoScalingRole ( const Aws::String value)
inline

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.

Definition at line 688 of file JobFlowDetail.h.

◆ SetAutoScalingRole() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetAutoScalingRole ( const char *  value)
inline

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.

Definition at line 704 of file JobFlowDetail.h.

◆ SetBootstrapActions() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetBootstrapActions ( Aws::Vector< BootstrapActionDetail > &&  value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 396 of file JobFlowDetail.h.

◆ SetBootstrapActions() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetBootstrapActions ( const Aws::Vector< BootstrapActionDetail > &  value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 391 of file JobFlowDetail.h.

◆ SetExecutionStatusDetail() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetExecutionStatusDetail ( const JobFlowExecutionStatusDetail value)
inline

Describes the execution status of the job flow.

Definition at line 288 of file JobFlowDetail.h.

◆ SetExecutionStatusDetail() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetExecutionStatusDetail ( JobFlowExecutionStatusDetail &&  value)
inline

Describes the execution status of the job flow.

Definition at line 293 of file JobFlowDetail.h.

◆ SetInstances() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetInstances ( const JobFlowInstancesDetail value)
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 319 of file JobFlowDetail.h.

◆ SetInstances() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetInstances ( JobFlowInstancesDetail &&  value)
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 324 of file JobFlowDetail.h.

◆ SetJobFlowId() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowId ( Aws::String &&  value)
inline

The job flow identifier.

Definition at line 64 of file JobFlowDetail.h.

◆ SetJobFlowId() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowId ( const Aws::String value)
inline

The job flow identifier.

Definition at line 59 of file JobFlowDetail.h.

◆ SetJobFlowId() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowId ( const char *  value)
inline

The job flow identifier.

Definition at line 69 of file JobFlowDetail.h.

◆ SetJobFlowRole() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowRole ( Aws::String &&  value)
inline

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

Definition at line 590 of file JobFlowDetail.h.

◆ SetJobFlowRole() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowRole ( const Aws::String value)
inline

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

Definition at line 584 of file JobFlowDetail.h.

◆ SetJobFlowRole() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetJobFlowRole ( const char *  value)
inline

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

Definition at line 596 of file JobFlowDetail.h.

◆ SetLogEncryptionKmsKeyId() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetLogEncryptionKmsKeyId ( Aws::String &&  value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 191 of file JobFlowDetail.h.

◆ SetLogEncryptionKmsKeyId() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetLogEncryptionKmsKeyId ( const Aws::String value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 185 of file JobFlowDetail.h.

◆ SetLogEncryptionKmsKeyId() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetLogEncryptionKmsKeyId ( const char *  value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 197 of file JobFlowDetail.h.

◆ SetLogUri() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetLogUri ( Aws::String &&  value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 146 of file JobFlowDetail.h.

◆ SetLogUri() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetLogUri ( const Aws::String value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 141 of file JobFlowDetail.h.

◆ SetLogUri() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetLogUri ( const char *  value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 151 of file JobFlowDetail.h.

◆ SetName() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetName ( Aws::String &&  value)
inline

The name of the job flow.

Definition at line 105 of file JobFlowDetail.h.

◆ SetName() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetName ( const Aws::String value)
inline

The name of the job flow.

Definition at line 100 of file JobFlowDetail.h.

◆ SetName() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetName ( const char *  value)
inline

The name of the job flow.

Definition at line 110 of file JobFlowDetail.h.

◆ SetScaleDownBehavior() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetScaleDownBehavior ( const ScaleDownBehavior value)
inline

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 adds nodes to a deny list 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.

Definition at line 780 of file JobFlowDetail.h.

◆ SetScaleDownBehavior() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetScaleDownBehavior ( ScaleDownBehavior &&  value)
inline

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 adds nodes to a deny list 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.

Definition at line 797 of file JobFlowDetail.h.

◆ SetServiceRole() [1/3]

void Aws::EMR::Model::JobFlowDetail::SetServiceRole ( Aws::String &&  value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 639 of file JobFlowDetail.h.

◆ SetServiceRole() [2/3]

void Aws::EMR::Model::JobFlowDetail::SetServiceRole ( const Aws::String value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 633 of file JobFlowDetail.h.

◆ SetServiceRole() [3/3]

void Aws::EMR::Model::JobFlowDetail::SetServiceRole ( const char *  value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 645 of file JobFlowDetail.h.

◆ SetSteps() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetSteps ( Aws::Vector< StepDetail > &&  value)
inline

A list of steps run by the job flow.

Definition at line 355 of file JobFlowDetail.h.

◆ SetSteps() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetSteps ( const Aws::Vector< StepDetail > &  value)
inline

A list of steps run by the job flow.

Definition at line 350 of file JobFlowDetail.h.

◆ SetSupportedProducts() [1/2]

void Aws::EMR::Model::JobFlowDetail::SetSupportedProducts ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 445 of file JobFlowDetail.h.

◆ SetSupportedProducts() [2/2]

void Aws::EMR::Model::JobFlowDetail::SetSupportedProducts ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 438 of file JobFlowDetail.h.

◆ SetVisibleToAllUsers()

void Aws::EMR::Model::JobFlowDetail::SetVisibleToAllUsers ( bool  value)
inline

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is true if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Definition at line 544 of file JobFlowDetail.h.

◆ StepsHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::StepsHasBeenSet ( ) const
inline

A list of steps run by the job flow.

Definition at line 345 of file JobFlowDetail.h.

◆ SupportedProductsHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::SupportedProductsHasBeenSet ( ) const
inline

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.

Definition at line 431 of file JobFlowDetail.h.

◆ VisibleToAllUsersHasBeenSet()

bool Aws::EMR::Model::JobFlowDetail::VisibleToAllUsersHasBeenSet ( ) const
inline

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is true if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Definition at line 523 of file JobFlowDetail.h.

◆ WithAmiVersion() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAmiVersion ( Aws::String &&  value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 265 of file JobFlowDetail.h.

◆ WithAmiVersion() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAmiVersion ( const Aws::String value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 258 of file JobFlowDetail.h.

◆ WithAmiVersion() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAmiVersion ( const char *  value)
inline

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Definition at line 272 of file JobFlowDetail.h.

◆ WithAutoScalingRole() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAutoScalingRole ( Aws::String &&  value)
inline

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.

Definition at line 720 of file JobFlowDetail.h.

◆ WithAutoScalingRole() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAutoScalingRole ( const Aws::String value)
inline

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.

Definition at line 712 of file JobFlowDetail.h.

◆ WithAutoScalingRole() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithAutoScalingRole ( const char *  value)
inline

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.

Definition at line 728 of file JobFlowDetail.h.

◆ WithBootstrapActions() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithBootstrapActions ( Aws::Vector< BootstrapActionDetail > &&  value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 406 of file JobFlowDetail.h.

◆ WithBootstrapActions() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithBootstrapActions ( const Aws::Vector< BootstrapActionDetail > &  value)
inline

A list of the bootstrap actions run by the job flow.

Definition at line 401 of file JobFlowDetail.h.

◆ WithExecutionStatusDetail() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithExecutionStatusDetail ( const JobFlowExecutionStatusDetail value)
inline

Describes the execution status of the job flow.

Definition at line 298 of file JobFlowDetail.h.

◆ WithExecutionStatusDetail() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithExecutionStatusDetail ( JobFlowExecutionStatusDetail &&  value)
inline

Describes the execution status of the job flow.

Definition at line 303 of file JobFlowDetail.h.

◆ WithInstances() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithInstances ( const JobFlowInstancesDetail value)
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 329 of file JobFlowDetail.h.

◆ WithInstances() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithInstances ( JobFlowInstancesDetail &&  value)
inline

Describes the Amazon EC2 instances of the job flow.

Definition at line 334 of file JobFlowDetail.h.

◆ WithJobFlowId() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowId ( Aws::String &&  value)
inline

The job flow identifier.

Definition at line 79 of file JobFlowDetail.h.

◆ WithJobFlowId() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowId ( const Aws::String value)
inline

The job flow identifier.

Definition at line 74 of file JobFlowDetail.h.

◆ WithJobFlowId() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowId ( const char *  value)
inline

The job flow identifier.

Definition at line 84 of file JobFlowDetail.h.

◆ WithJobFlowRole() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowRole ( Aws::String &&  value)
inline

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

Definition at line 608 of file JobFlowDetail.h.

◆ WithJobFlowRole() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowRole ( const Aws::String value)
inline

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

Definition at line 602 of file JobFlowDetail.h.

◆ WithJobFlowRole() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithJobFlowRole ( const char *  value)
inline

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

Definition at line 614 of file JobFlowDetail.h.

◆ WithLogEncryptionKmsKeyId() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogEncryptionKmsKeyId ( Aws::String &&  value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 209 of file JobFlowDetail.h.

◆ WithLogEncryptionKmsKeyId() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogEncryptionKmsKeyId ( const Aws::String value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 203 of file JobFlowDetail.h.

◆ WithLogEncryptionKmsKeyId() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogEncryptionKmsKeyId ( const char *  value)
inline

The KMS key used for encrypting log files. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Definition at line 215 of file JobFlowDetail.h.

◆ WithLogUri() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogUri ( Aws::String &&  value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 161 of file JobFlowDetail.h.

◆ WithLogUri() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogUri ( const Aws::String value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 156 of file JobFlowDetail.h.

◆ WithLogUri() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithLogUri ( const char *  value)
inline

The location in Amazon S3 where log files for the job are stored.

Definition at line 166 of file JobFlowDetail.h.

◆ WithName() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithName ( Aws::String &&  value)
inline

The name of the job flow.

Definition at line 120 of file JobFlowDetail.h.

◆ WithName() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithName ( const Aws::String value)
inline

The name of the job flow.

Definition at line 115 of file JobFlowDetail.h.

◆ WithName() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithName ( const char *  value)
inline

The name of the job flow.

Definition at line 125 of file JobFlowDetail.h.

◆ WithScaleDownBehavior() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithScaleDownBehavior ( const ScaleDownBehavior value)
inline

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 adds nodes to a deny list 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.

Definition at line 814 of file JobFlowDetail.h.

◆ WithScaleDownBehavior() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithScaleDownBehavior ( ScaleDownBehavior &&  value)
inline

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 adds nodes to a deny list 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.

Definition at line 831 of file JobFlowDetail.h.

◆ WithServiceRole() [1/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithServiceRole ( Aws::String &&  value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 657 of file JobFlowDetail.h.

◆ WithServiceRole() [2/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithServiceRole ( const Aws::String value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 651 of file JobFlowDetail.h.

◆ WithServiceRole() [3/3]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithServiceRole ( const char *  value)
inline

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

Definition at line 663 of file JobFlowDetail.h.

◆ WithSteps() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithSteps ( Aws::Vector< StepDetail > &&  value)
inline

A list of steps run by the job flow.

Definition at line 365 of file JobFlowDetail.h.

◆ WithSteps() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithSteps ( const Aws::Vector< StepDetail > &  value)
inline

A list of steps run by the job flow.

Definition at line 360 of file JobFlowDetail.h.

◆ WithSupportedProducts() [1/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithSupportedProducts ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 459 of file JobFlowDetail.h.

◆ WithSupportedProducts() [2/2]

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithSupportedProducts ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 452 of file JobFlowDetail.h.

◆ WithVisibleToAllUsers()

JobFlowDetail& Aws::EMR::Model::JobFlowDetail::WithVisibleToAllUsers ( bool  value)
inline

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is true if a value is not provided when creating a cluster using the EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Definition at line 565 of file JobFlowDetail.h.


The documentation for this class was generated from the following file: