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

#include <Cluster.h>

Public Member Functions

 Cluster ()
 
 Cluster (Aws::Utils::Json::JsonView jsonValue)
 
Clusteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
ClusterWithId (const Aws::String &value)
 
ClusterWithId (Aws::String &&value)
 
ClusterWithId (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)
 
ClusterWithName (const Aws::String &value)
 
ClusterWithName (Aws::String &&value)
 
ClusterWithName (const char *value)
 
const ClusterStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ClusterStatus &value)
 
void SetStatus (ClusterStatus &&value)
 
ClusterWithStatus (const ClusterStatus &value)
 
ClusterWithStatus (ClusterStatus &&value)
 
const Ec2InstanceAttributesGetEc2InstanceAttributes () const
 
bool Ec2InstanceAttributesHasBeenSet () const
 
void SetEc2InstanceAttributes (const Ec2InstanceAttributes &value)
 
void SetEc2InstanceAttributes (Ec2InstanceAttributes &&value)
 
ClusterWithEc2InstanceAttributes (const Ec2InstanceAttributes &value)
 
ClusterWithEc2InstanceAttributes (Ec2InstanceAttributes &&value)
 
const InstanceCollectionTypeGetInstanceCollectionType () const
 
bool InstanceCollectionTypeHasBeenSet () const
 
void SetInstanceCollectionType (const InstanceCollectionType &value)
 
void SetInstanceCollectionType (InstanceCollectionType &&value)
 
ClusterWithInstanceCollectionType (const InstanceCollectionType &value)
 
ClusterWithInstanceCollectionType (InstanceCollectionType &&value)
 
const Aws::StringGetLogUri () const
 
bool LogUriHasBeenSet () const
 
void SetLogUri (const Aws::String &value)
 
void SetLogUri (Aws::String &&value)
 
void SetLogUri (const char *value)
 
ClusterWithLogUri (const Aws::String &value)
 
ClusterWithLogUri (Aws::String &&value)
 
ClusterWithLogUri (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)
 
ClusterWithLogEncryptionKmsKeyId (const Aws::String &value)
 
ClusterWithLogEncryptionKmsKeyId (Aws::String &&value)
 
ClusterWithLogEncryptionKmsKeyId (const char *value)
 
const Aws::StringGetRequestedAmiVersion () const
 
bool RequestedAmiVersionHasBeenSet () const
 
void SetRequestedAmiVersion (const Aws::String &value)
 
void SetRequestedAmiVersion (Aws::String &&value)
 
void SetRequestedAmiVersion (const char *value)
 
ClusterWithRequestedAmiVersion (const Aws::String &value)
 
ClusterWithRequestedAmiVersion (Aws::String &&value)
 
ClusterWithRequestedAmiVersion (const char *value)
 
const Aws::StringGetRunningAmiVersion () const
 
bool RunningAmiVersionHasBeenSet () const
 
void SetRunningAmiVersion (const Aws::String &value)
 
void SetRunningAmiVersion (Aws::String &&value)
 
void SetRunningAmiVersion (const char *value)
 
ClusterWithRunningAmiVersion (const Aws::String &value)
 
ClusterWithRunningAmiVersion (Aws::String &&value)
 
ClusterWithRunningAmiVersion (const char *value)
 
const Aws::StringGetReleaseLabel () const
 
bool ReleaseLabelHasBeenSet () const
 
void SetReleaseLabel (const Aws::String &value)
 
void SetReleaseLabel (Aws::String &&value)
 
void SetReleaseLabel (const char *value)
 
ClusterWithReleaseLabel (const Aws::String &value)
 
ClusterWithReleaseLabel (Aws::String &&value)
 
ClusterWithReleaseLabel (const char *value)
 
bool GetAutoTerminate () const
 
bool AutoTerminateHasBeenSet () const
 
void SetAutoTerminate (bool value)
 
ClusterWithAutoTerminate (bool value)
 
bool GetTerminationProtected () const
 
bool TerminationProtectedHasBeenSet () const
 
void SetTerminationProtected (bool value)
 
ClusterWithTerminationProtected (bool value)
 
bool GetVisibleToAllUsers () const
 
bool VisibleToAllUsersHasBeenSet () const
 
void SetVisibleToAllUsers (bool value)
 
ClusterWithVisibleToAllUsers (bool value)
 
const Aws::Vector< Application > & GetApplications () const
 
bool ApplicationsHasBeenSet () const
 
void SetApplications (const Aws::Vector< Application > &value)
 
void SetApplications (Aws::Vector< Application > &&value)
 
ClusterWithApplications (const Aws::Vector< Application > &value)
 
ClusterWithApplications (Aws::Vector< Application > &&value)
 
ClusterAddApplications (const Application &value)
 
ClusterAddApplications (Application &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
ClusterWithTags (const Aws::Vector< Tag > &value)
 
ClusterWithTags (Aws::Vector< Tag > &&value)
 
ClusterAddTags (const Tag &value)
 
ClusterAddTags (Tag &&value)
 
const Aws::StringGetServiceRole () const
 
bool ServiceRoleHasBeenSet () const
 
void SetServiceRole (const Aws::String &value)
 
void SetServiceRole (Aws::String &&value)
 
void SetServiceRole (const char *value)
 
ClusterWithServiceRole (const Aws::String &value)
 
ClusterWithServiceRole (Aws::String &&value)
 
ClusterWithServiceRole (const char *value)
 
int GetNormalizedInstanceHours () const
 
bool NormalizedInstanceHoursHasBeenSet () const
 
void SetNormalizedInstanceHours (int value)
 
ClusterWithNormalizedInstanceHours (int value)
 
const Aws::StringGetMasterPublicDnsName () const
 
bool MasterPublicDnsNameHasBeenSet () const
 
void SetMasterPublicDnsName (const Aws::String &value)
 
void SetMasterPublicDnsName (Aws::String &&value)
 
void SetMasterPublicDnsName (const char *value)
 
ClusterWithMasterPublicDnsName (const Aws::String &value)
 
ClusterWithMasterPublicDnsName (Aws::String &&value)
 
ClusterWithMasterPublicDnsName (const char *value)
 
const Aws::Vector< Configuration > & GetConfigurations () const
 
bool ConfigurationsHasBeenSet () const
 
void SetConfigurations (const Aws::Vector< Configuration > &value)
 
void SetConfigurations (Aws::Vector< Configuration > &&value)
 
ClusterWithConfigurations (const Aws::Vector< Configuration > &value)
 
ClusterWithConfigurations (Aws::Vector< Configuration > &&value)
 
ClusterAddConfigurations (const Configuration &value)
 
ClusterAddConfigurations (Configuration &&value)
 
const Aws::StringGetSecurityConfiguration () const
 
bool SecurityConfigurationHasBeenSet () const
 
void SetSecurityConfiguration (const Aws::String &value)
 
void SetSecurityConfiguration (Aws::String &&value)
 
void SetSecurityConfiguration (const char *value)
 
ClusterWithSecurityConfiguration (const Aws::String &value)
 
ClusterWithSecurityConfiguration (Aws::String &&value)
 
ClusterWithSecurityConfiguration (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)
 
ClusterWithAutoScalingRole (const Aws::String &value)
 
ClusterWithAutoScalingRole (Aws::String &&value)
 
ClusterWithAutoScalingRole (const char *value)
 
const ScaleDownBehaviorGetScaleDownBehavior () const
 
bool ScaleDownBehaviorHasBeenSet () const
 
void SetScaleDownBehavior (const ScaleDownBehavior &value)
 
void SetScaleDownBehavior (ScaleDownBehavior &&value)
 
ClusterWithScaleDownBehavior (const ScaleDownBehavior &value)
 
ClusterWithScaleDownBehavior (ScaleDownBehavior &&value)
 
const Aws::StringGetCustomAmiId () const
 
bool CustomAmiIdHasBeenSet () const
 
void SetCustomAmiId (const Aws::String &value)
 
void SetCustomAmiId (Aws::String &&value)
 
void SetCustomAmiId (const char *value)
 
ClusterWithCustomAmiId (const Aws::String &value)
 
ClusterWithCustomAmiId (Aws::String &&value)
 
ClusterWithCustomAmiId (const char *value)
 
int GetEbsRootVolumeSize () const
 
bool EbsRootVolumeSizeHasBeenSet () const
 
void SetEbsRootVolumeSize (int value)
 
ClusterWithEbsRootVolumeSize (int value)
 
const RepoUpgradeOnBootGetRepoUpgradeOnBoot () const
 
bool RepoUpgradeOnBootHasBeenSet () const
 
void SetRepoUpgradeOnBoot (const RepoUpgradeOnBoot &value)
 
void SetRepoUpgradeOnBoot (RepoUpgradeOnBoot &&value)
 
ClusterWithRepoUpgradeOnBoot (const RepoUpgradeOnBoot &value)
 
ClusterWithRepoUpgradeOnBoot (RepoUpgradeOnBoot &&value)
 
const KerberosAttributesGetKerberosAttributes () const
 
bool KerberosAttributesHasBeenSet () const
 
void SetKerberosAttributes (const KerberosAttributes &value)
 
void SetKerberosAttributes (KerberosAttributes &&value)
 
ClusterWithKerberosAttributes (const KerberosAttributes &value)
 
ClusterWithKerberosAttributes (KerberosAttributes &&value)
 
const Aws::StringGetClusterArn () const
 
bool ClusterArnHasBeenSet () const
 
void SetClusterArn (const Aws::String &value)
 
void SetClusterArn (Aws::String &&value)
 
void SetClusterArn (const char *value)
 
ClusterWithClusterArn (const Aws::String &value)
 
ClusterWithClusterArn (Aws::String &&value)
 
ClusterWithClusterArn (const char *value)
 
const Aws::StringGetOutpostArn () const
 
bool OutpostArnHasBeenSet () const
 
void SetOutpostArn (const Aws::String &value)
 
void SetOutpostArn (Aws::String &&value)
 
void SetOutpostArn (const char *value)
 
ClusterWithOutpostArn (const Aws::String &value)
 
ClusterWithOutpostArn (Aws::String &&value)
 
ClusterWithOutpostArn (const char *value)
 
int GetStepConcurrencyLevel () const
 
bool StepConcurrencyLevelHasBeenSet () const
 
void SetStepConcurrencyLevel (int value)
 
ClusterWithStepConcurrencyLevel (int value)
 
const Aws::Vector< PlacementGroupConfig > & GetPlacementGroups () const
 
bool PlacementGroupsHasBeenSet () const
 
void SetPlacementGroups (const Aws::Vector< PlacementGroupConfig > &value)
 
void SetPlacementGroups (Aws::Vector< PlacementGroupConfig > &&value)
 
ClusterWithPlacementGroups (const Aws::Vector< PlacementGroupConfig > &value)
 
ClusterWithPlacementGroups (Aws::Vector< PlacementGroupConfig > &&value)
 
ClusterAddPlacementGroups (const PlacementGroupConfig &value)
 
ClusterAddPlacementGroups (PlacementGroupConfig &&value)
 

Detailed Description

The detailed description of the cluster.

See Also:

AWS API Reference

Definition at line 42 of file Cluster.h.

Constructor & Destructor Documentation

◆ Cluster() [1/2]

Aws::EMR::Model::Cluster::Cluster ( )

◆ Cluster() [2/2]

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

Member Function Documentation

◆ AddApplications() [1/2]

Cluster& Aws::EMR::Model::Cluster::AddApplications ( Application &&  value)
inline

The applications installed on this cluster.

Definition at line 710 of file Cluster.h.

◆ AddApplications() [2/2]

Cluster& Aws::EMR::Model::Cluster::AddApplications ( const Application value)
inline

The applications installed on this cluster.

Definition at line 705 of file Cluster.h.

◆ AddConfigurations() [1/2]

Cluster& Aws::EMR::Model::Cluster::AddConfigurations ( Configuration &&  value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 939 of file Cluster.h.

◆ AddConfigurations() [2/2]

Cluster& Aws::EMR::Model::Cluster::AddConfigurations ( const Configuration value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 933 of file Cluster.h.

◆ AddPlacementGroups() [1/2]

Cluster& Aws::EMR::Model::Cluster::AddPlacementGroups ( const PlacementGroupConfig value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1465 of file Cluster.h.

◆ AddPlacementGroups() [2/2]

Cluster& Aws::EMR::Model::Cluster::AddPlacementGroups ( PlacementGroupConfig &&  value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1470 of file Cluster.h.

◆ AddTags() [1/2]

Cluster& Aws::EMR::Model::Cluster::AddTags ( const Tag value)
inline

A list of tags associated with a cluster.

Definition at line 746 of file Cluster.h.

◆ AddTags() [2/2]

Cluster& Aws::EMR::Model::Cluster::AddTags ( Tag &&  value)
inline

A list of tags associated with a cluster.

Definition at line 751 of file Cluster.h.

◆ ApplicationsHasBeenSet()

bool Aws::EMR::Model::Cluster::ApplicationsHasBeenSet ( ) const
inline

The applications installed on this cluster.

Definition at line 680 of file Cluster.h.

◆ AutoScalingRoleHasBeenSet()

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 997 of file Cluster.h.

◆ AutoTerminateHasBeenSet()

bool Aws::EMR::Model::Cluster::AutoTerminateHasBeenSet ( ) const
inline

Specifies whether the cluster should terminate after completing all steps.

Definition at line 543 of file Cluster.h.

◆ ClusterArnHasBeenSet()

bool Aws::EMR::Model::Cluster::ClusterArnHasBeenSet ( ) const
inline

The Amazon Resource Name of the cluster.

Definition at line 1329 of file Cluster.h.

◆ ConfigurationsHasBeenSet()

bool Aws::EMR::Model::Cluster::ConfigurationsHasBeenSet ( ) const
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 903 of file Cluster.h.

◆ CustomAmiIdHasBeenSet()

bool Aws::EMR::Model::Cluster::CustomAmiIdHasBeenSet ( ) const
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1161 of file Cluster.h.

◆ EbsRootVolumeSizeHasBeenSet()

bool Aws::EMR::Model::Cluster::EbsRootVolumeSizeHasBeenSet ( ) const
inline

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Definition at line 1212 of file Cluster.h.

◆ Ec2InstanceAttributesHasBeenSet()

bool Aws::EMR::Model::Cluster::Ec2InstanceAttributesHasBeenSet ( ) const
inline

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

Definition at line 174 of file Cluster.h.

◆ GetApplications()

const Aws::Vector<Application>& Aws::EMR::Model::Cluster::GetApplications ( ) const
inline

The applications installed on this cluster.

Definition at line 675 of file Cluster.h.

◆ GetAutoScalingRole()

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 989 of file Cluster.h.

◆ GetAutoTerminate()

bool Aws::EMR::Model::Cluster::GetAutoTerminate ( ) const
inline

Specifies whether the cluster should terminate after completing all steps.

Definition at line 537 of file Cluster.h.

◆ GetClusterArn()

const Aws::String& Aws::EMR::Model::Cluster::GetClusterArn ( ) const
inline

The Amazon Resource Name of the cluster.

Definition at line 1324 of file Cluster.h.

◆ GetConfigurations()

const Aws::Vector<Configuration>& Aws::EMR::Model::Cluster::GetConfigurations ( ) const
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 897 of file Cluster.h.

◆ GetCustomAmiId()

const Aws::String& Aws::EMR::Model::Cluster::GetCustomAmiId ( ) const
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1155 of file Cluster.h.

◆ GetEbsRootVolumeSize()

int Aws::EMR::Model::Cluster::GetEbsRootVolumeSize ( ) const
inline

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Definition at line 1205 of file Cluster.h.

◆ GetEc2InstanceAttributes()

const Ec2InstanceAttributes& Aws::EMR::Model::Cluster::GetEc2InstanceAttributes ( ) const
inline

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

Definition at line 168 of file Cluster.h.

◆ GetId()

const Aws::String& Aws::EMR::Model::Cluster::GetId ( ) const
inline

The unique identifier for the cluster.

Definition at line 54 of file Cluster.h.

◆ GetInstanceCollectionType()

const InstanceCollectionType& Aws::EMR::Model::Cluster::GetInstanceCollectionType ( ) const
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 208 of file Cluster.h.

◆ GetKerberosAttributes()

const KerberosAttributes& Aws::EMR::Model::Cluster::GetKerberosAttributes ( ) const
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1278 of file Cluster.h.

◆ GetLogEncryptionKmsKeyId()

const Aws::String& Aws::EMR::Model::Cluster::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 309 of file Cluster.h.

◆ GetLogUri()

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 260 of file Cluster.h.

◆ GetMasterPublicDnsName()

const Aws::String& Aws::EMR::Model::Cluster::GetMasterPublicDnsName ( ) const
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 848 of file Cluster.h.

◆ GetName()

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

The name of the cluster.

Definition at line 95 of file Cluster.h.

◆ GetNormalizedInstanceHours()

int Aws::EMR::Model::Cluster::GetNormalizedInstanceHours ( ) const
inline

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Definition at line 811 of file Cluster.h.

◆ GetOutpostArn()

const Aws::String& Aws::EMR::Model::Cluster::GetOutpostArn ( ) const
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1366 of file Cluster.h.

◆ GetPlacementGroups()

const Aws::Vector<PlacementGroupConfig>& Aws::EMR::Model::Cluster::GetPlacementGroups ( ) const
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1435 of file Cluster.h.

◆ GetReleaseLabel()

const Aws::String& Aws::EMR::Model::Cluster::GetReleaseLabel ( ) const
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 446 of file Cluster.h.

◆ GetRepoUpgradeOnBoot()

const RepoUpgradeOnBoot& Aws::EMR::Model::Cluster::GetRepoUpgradeOnBoot ( ) const
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1234 of file Cluster.h.

◆ GetRequestedAmiVersion()

const Aws::String& Aws::EMR::Model::Cluster::GetRequestedAmiVersion ( ) const
inline

The AMI version requested for this cluster.

Definition at line 357 of file Cluster.h.

◆ GetRunningAmiVersion()

const Aws::String& Aws::EMR::Model::Cluster::GetRunningAmiVersion ( ) const
inline

The AMI version running on this cluster.

Definition at line 398 of file Cluster.h.

◆ GetScaleDownBehavior()

const ScaleDownBehavior& Aws::EMR::Model::Cluster::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 is 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 1063 of file Cluster.h.

◆ GetSecurityConfiguration()

const Aws::String& Aws::EMR::Model::Cluster::GetSecurityConfiguration ( ) const
inline

The name of the security configuration applied to the cluster.

Definition at line 945 of file Cluster.h.

◆ GetServiceRole()

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 758 of file Cluster.h.

◆ GetStatus()

const ClusterStatus& Aws::EMR::Model::Cluster::GetStatus ( ) const
inline

The current status details about the cluster.

Definition at line 136 of file Cluster.h.

◆ GetStepConcurrencyLevel()

int Aws::EMR::Model::Cluster::GetStepConcurrencyLevel ( ) const
inline

Specifies the number of steps that can be executed concurrently.

Definition at line 1414 of file Cluster.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EMR::Model::Cluster::GetTags ( ) const
inline

A list of tags associated with a cluster.

Definition at line 716 of file Cluster.h.

◆ GetTerminationProtected()

bool Aws::EMR::Model::Cluster::GetTerminationProtected ( ) const
inline

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Definition at line 563 of file Cluster.h.

◆ GetVisibleToAllUsers()

bool Aws::EMR::Model::Cluster::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 on the cluster 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 allowed 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 606 of file Cluster.h.

◆ IdHasBeenSet()

bool Aws::EMR::Model::Cluster::IdHasBeenSet ( ) const
inline

The unique identifier for the cluster.

Definition at line 59 of file Cluster.h.

◆ InstanceCollectionTypeHasBeenSet()

bool Aws::EMR::Model::Cluster::InstanceCollectionTypeHasBeenSet ( ) const
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 217 of file Cluster.h.

◆ Jsonize()

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

◆ KerberosAttributesHasBeenSet()

bool Aws::EMR::Model::Cluster::KerberosAttributesHasBeenSet ( ) const
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1286 of file Cluster.h.

◆ LogEncryptionKmsKeyIdHasBeenSet()

bool Aws::EMR::Model::Cluster::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 315 of file Cluster.h.

◆ LogUriHasBeenSet()

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 266 of file Cluster.h.

◆ MasterPublicDnsNameHasBeenSet()

bool Aws::EMR::Model::Cluster::MasterPublicDnsNameHasBeenSet ( ) const
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 854 of file Cluster.h.

◆ NameHasBeenSet()

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

The name of the cluster.

Definition at line 100 of file Cluster.h.

◆ NormalizedInstanceHoursHasBeenSet()

bool Aws::EMR::Model::Cluster::NormalizedInstanceHoursHasBeenSet ( ) const
inline

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Definition at line 821 of file Cluster.h.

◆ operator=()

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

◆ OutpostArnHasBeenSet()

bool Aws::EMR::Model::Cluster::OutpostArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1372 of file Cluster.h.

◆ PlacementGroupsHasBeenSet()

bool Aws::EMR::Model::Cluster::PlacementGroupsHasBeenSet ( ) const
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1440 of file Cluster.h.

◆ ReleaseLabelHasBeenSet()

bool Aws::EMR::Model::Cluster::ReleaseLabelHasBeenSet ( ) const
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 458 of file Cluster.h.

◆ RepoUpgradeOnBootHasBeenSet()

bool Aws::EMR::Model::Cluster::RepoUpgradeOnBootHasBeenSet ( ) const
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1241 of file Cluster.h.

◆ RequestedAmiVersionHasBeenSet()

bool Aws::EMR::Model::Cluster::RequestedAmiVersionHasBeenSet ( ) const
inline

The AMI version requested for this cluster.

Definition at line 362 of file Cluster.h.

◆ RunningAmiVersionHasBeenSet()

bool Aws::EMR::Model::Cluster::RunningAmiVersionHasBeenSet ( ) const
inline

The AMI version running on this cluster.

Definition at line 403 of file Cluster.h.

◆ ScaleDownBehaviorHasBeenSet()

bool Aws::EMR::Model::Cluster::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 is 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 1080 of file Cluster.h.

◆ SecurityConfigurationHasBeenSet()

bool Aws::EMR::Model::Cluster::SecurityConfigurationHasBeenSet ( ) const
inline

The name of the security configuration applied to the cluster.

Definition at line 950 of file Cluster.h.

◆ ServiceRoleHasBeenSet()

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 764 of file Cluster.h.

◆ SetApplications() [1/2]

void Aws::EMR::Model::Cluster::SetApplications ( Aws::Vector< Application > &&  value)
inline

The applications installed on this cluster.

Definition at line 690 of file Cluster.h.

◆ SetApplications() [2/2]

void Aws::EMR::Model::Cluster::SetApplications ( const Aws::Vector< Application > &  value)
inline

The applications installed on this cluster.

Definition at line 685 of file Cluster.h.

◆ SetAutoScalingRole() [1/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1013 of file Cluster.h.

◆ SetAutoScalingRole() [2/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1005 of file Cluster.h.

◆ SetAutoScalingRole() [3/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1021 of file Cluster.h.

◆ SetAutoTerminate()

void Aws::EMR::Model::Cluster::SetAutoTerminate ( bool  value)
inline

Specifies whether the cluster should terminate after completing all steps.

Definition at line 549 of file Cluster.h.

◆ SetClusterArn() [1/3]

void Aws::EMR::Model::Cluster::SetClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1339 of file Cluster.h.

◆ SetClusterArn() [2/3]

void Aws::EMR::Model::Cluster::SetClusterArn ( const Aws::String value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1334 of file Cluster.h.

◆ SetClusterArn() [3/3]

void Aws::EMR::Model::Cluster::SetClusterArn ( const char *  value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1344 of file Cluster.h.

◆ SetConfigurations() [1/2]

void Aws::EMR::Model::Cluster::SetConfigurations ( Aws::Vector< Configuration > &&  value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 915 of file Cluster.h.

◆ SetConfigurations() [2/2]

void Aws::EMR::Model::Cluster::SetConfigurations ( const Aws::Vector< Configuration > &  value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 909 of file Cluster.h.

◆ SetCustomAmiId() [1/3]

void Aws::EMR::Model::Cluster::SetCustomAmiId ( Aws::String &&  value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1173 of file Cluster.h.

◆ SetCustomAmiId() [2/3]

void Aws::EMR::Model::Cluster::SetCustomAmiId ( const Aws::String value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1167 of file Cluster.h.

◆ SetCustomAmiId() [3/3]

void Aws::EMR::Model::Cluster::SetCustomAmiId ( const char *  value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1179 of file Cluster.h.

◆ SetEbsRootVolumeSize()

void Aws::EMR::Model::Cluster::SetEbsRootVolumeSize ( int  value)
inline

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Definition at line 1219 of file Cluster.h.

◆ SetEc2InstanceAttributes() [1/2]

void Aws::EMR::Model::Cluster::SetEc2InstanceAttributes ( const Ec2InstanceAttributes value)
inline

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

Definition at line 180 of file Cluster.h.

◆ SetEc2InstanceAttributes() [2/2]

void Aws::EMR::Model::Cluster::SetEc2InstanceAttributes ( Ec2InstanceAttributes &&  value)
inline

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

Definition at line 186 of file Cluster.h.

◆ SetId() [1/3]

void Aws::EMR::Model::Cluster::SetId ( Aws::String &&  value)
inline

The unique identifier for the cluster.

Definition at line 69 of file Cluster.h.

◆ SetId() [2/3]

void Aws::EMR::Model::Cluster::SetId ( const Aws::String value)
inline

The unique identifier for the cluster.

Definition at line 64 of file Cluster.h.

◆ SetId() [3/3]

void Aws::EMR::Model::Cluster::SetId ( const char *  value)
inline

The unique identifier for the cluster.

Definition at line 74 of file Cluster.h.

◆ SetInstanceCollectionType() [1/2]

void Aws::EMR::Model::Cluster::SetInstanceCollectionType ( const InstanceCollectionType value)
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 226 of file Cluster.h.

◆ SetInstanceCollectionType() [2/2]

void Aws::EMR::Model::Cluster::SetInstanceCollectionType ( InstanceCollectionType &&  value)
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 235 of file Cluster.h.

◆ SetKerberosAttributes() [1/2]

void Aws::EMR::Model::Cluster::SetKerberosAttributes ( const KerberosAttributes value)
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1294 of file Cluster.h.

◆ SetKerberosAttributes() [2/2]

void Aws::EMR::Model::Cluster::SetKerberosAttributes ( KerberosAttributes &&  value)
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1302 of file Cluster.h.

◆ SetLogEncryptionKmsKeyId() [1/3]

void Aws::EMR::Model::Cluster::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 327 of file Cluster.h.

◆ SetLogEncryptionKmsKeyId() [2/3]

void Aws::EMR::Model::Cluster::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 321 of file Cluster.h.

◆ SetLogEncryptionKmsKeyId() [3/3]

void Aws::EMR::Model::Cluster::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 333 of file Cluster.h.

◆ SetLogUri() [1/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 278 of file Cluster.h.

◆ SetLogUri() [2/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 272 of file Cluster.h.

◆ SetLogUri() [3/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 284 of file Cluster.h.

◆ SetMasterPublicDnsName() [1/3]

void Aws::EMR::Model::Cluster::SetMasterPublicDnsName ( Aws::String &&  value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 866 of file Cluster.h.

◆ SetMasterPublicDnsName() [2/3]

void Aws::EMR::Model::Cluster::SetMasterPublicDnsName ( const Aws::String value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 860 of file Cluster.h.

◆ SetMasterPublicDnsName() [3/3]

void Aws::EMR::Model::Cluster::SetMasterPublicDnsName ( const char *  value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 872 of file Cluster.h.

◆ SetName() [1/3]

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

The name of the cluster.

Definition at line 110 of file Cluster.h.

◆ SetName() [2/3]

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

The name of the cluster.

Definition at line 105 of file Cluster.h.

◆ SetName() [3/3]

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

The name of the cluster.

Definition at line 115 of file Cluster.h.

◆ SetNormalizedInstanceHours()

void Aws::EMR::Model::Cluster::SetNormalizedInstanceHours ( int  value)
inline

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Definition at line 831 of file Cluster.h.

◆ SetOutpostArn() [1/3]

void Aws::EMR::Model::Cluster::SetOutpostArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1384 of file Cluster.h.

◆ SetOutpostArn() [2/3]

void Aws::EMR::Model::Cluster::SetOutpostArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1378 of file Cluster.h.

◆ SetOutpostArn() [3/3]

void Aws::EMR::Model::Cluster::SetOutpostArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1390 of file Cluster.h.

◆ SetPlacementGroups() [1/2]

void Aws::EMR::Model::Cluster::SetPlacementGroups ( Aws::Vector< PlacementGroupConfig > &&  value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1450 of file Cluster.h.

◆ SetPlacementGroups() [2/2]

void Aws::EMR::Model::Cluster::SetPlacementGroups ( const Aws::Vector< PlacementGroupConfig > &  value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1445 of file Cluster.h.

◆ SetReleaseLabel() [1/3]

void Aws::EMR::Model::Cluster::SetReleaseLabel ( Aws::String &&  value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 482 of file Cluster.h.

◆ SetReleaseLabel() [2/3]

void Aws::EMR::Model::Cluster::SetReleaseLabel ( const Aws::String value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 470 of file Cluster.h.

◆ SetReleaseLabel() [3/3]

void Aws::EMR::Model::Cluster::SetReleaseLabel ( const char *  value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 494 of file Cluster.h.

◆ SetRepoUpgradeOnBoot() [1/2]

void Aws::EMR::Model::Cluster::SetRepoUpgradeOnBoot ( const RepoUpgradeOnBoot value)
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1248 of file Cluster.h.

◆ SetRepoUpgradeOnBoot() [2/2]

void Aws::EMR::Model::Cluster::SetRepoUpgradeOnBoot ( RepoUpgradeOnBoot &&  value)
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1255 of file Cluster.h.

◆ SetRequestedAmiVersion() [1/3]

void Aws::EMR::Model::Cluster::SetRequestedAmiVersion ( Aws::String &&  value)
inline

The AMI version requested for this cluster.

Definition at line 372 of file Cluster.h.

◆ SetRequestedAmiVersion() [2/3]

void Aws::EMR::Model::Cluster::SetRequestedAmiVersion ( const Aws::String value)
inline

The AMI version requested for this cluster.

Definition at line 367 of file Cluster.h.

◆ SetRequestedAmiVersion() [3/3]

void Aws::EMR::Model::Cluster::SetRequestedAmiVersion ( const char *  value)
inline

The AMI version requested for this cluster.

Definition at line 377 of file Cluster.h.

◆ SetRunningAmiVersion() [1/3]

void Aws::EMR::Model::Cluster::SetRunningAmiVersion ( Aws::String &&  value)
inline

The AMI version running on this cluster.

Definition at line 413 of file Cluster.h.

◆ SetRunningAmiVersion() [2/3]

void Aws::EMR::Model::Cluster::SetRunningAmiVersion ( const Aws::String value)
inline

The AMI version running on this cluster.

Definition at line 408 of file Cluster.h.

◆ SetRunningAmiVersion() [3/3]

void Aws::EMR::Model::Cluster::SetRunningAmiVersion ( const char *  value)
inline

The AMI version running on this cluster.

Definition at line 418 of file Cluster.h.

◆ SetScaleDownBehavior() [1/2]

void Aws::EMR::Model::Cluster::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 is 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 1097 of file Cluster.h.

◆ SetScaleDownBehavior() [2/2]

void Aws::EMR::Model::Cluster::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 is 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 1114 of file Cluster.h.

◆ SetSecurityConfiguration() [1/3]

void Aws::EMR::Model::Cluster::SetSecurityConfiguration ( Aws::String &&  value)
inline

The name of the security configuration applied to the cluster.

Definition at line 960 of file Cluster.h.

◆ SetSecurityConfiguration() [2/3]

void Aws::EMR::Model::Cluster::SetSecurityConfiguration ( const Aws::String value)
inline

The name of the security configuration applied to the cluster.

Definition at line 955 of file Cluster.h.

◆ SetSecurityConfiguration() [3/3]

void Aws::EMR::Model::Cluster::SetSecurityConfiguration ( const char *  value)
inline

The name of the security configuration applied to the cluster.

Definition at line 965 of file Cluster.h.

◆ SetServiceRole() [1/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 776 of file Cluster.h.

◆ SetServiceRole() [2/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 770 of file Cluster.h.

◆ SetServiceRole() [3/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 782 of file Cluster.h.

◆ SetStatus() [1/2]

void Aws::EMR::Model::Cluster::SetStatus ( ClusterStatus &&  value)
inline

The current status details about the cluster.

Definition at line 151 of file Cluster.h.

◆ SetStatus() [2/2]

void Aws::EMR::Model::Cluster::SetStatus ( const ClusterStatus value)
inline

The current status details about the cluster.

Definition at line 146 of file Cluster.h.

◆ SetStepConcurrencyLevel()

void Aws::EMR::Model::Cluster::SetStepConcurrencyLevel ( int  value)
inline

Specifies the number of steps that can be executed concurrently.

Definition at line 1424 of file Cluster.h.

◆ SetTags() [1/2]

void Aws::EMR::Model::Cluster::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags associated with a cluster.

Definition at line 731 of file Cluster.h.

◆ SetTags() [2/2]

void Aws::EMR::Model::Cluster::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags associated with a cluster.

Definition at line 726 of file Cluster.h.

◆ SetTerminationProtected()

void Aws::EMR::Model::Cluster::SetTerminationProtected ( bool  value)
inline

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Definition at line 577 of file Cluster.h.

◆ SetVisibleToAllUsers()

void Aws::EMR::Model::Cluster::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 on the cluster 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 allowed 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 648 of file Cluster.h.

◆ StatusHasBeenSet()

bool Aws::EMR::Model::Cluster::StatusHasBeenSet ( ) const
inline

The current status details about the cluster.

Definition at line 141 of file Cluster.h.

◆ StepConcurrencyLevelHasBeenSet()

bool Aws::EMR::Model::Cluster::StepConcurrencyLevelHasBeenSet ( ) const
inline

Specifies the number of steps that can be executed concurrently.

Definition at line 1419 of file Cluster.h.

◆ TagsHasBeenSet()

bool Aws::EMR::Model::Cluster::TagsHasBeenSet ( ) const
inline

A list of tags associated with a cluster.

Definition at line 721 of file Cluster.h.

◆ TerminationProtectedHasBeenSet()

bool Aws::EMR::Model::Cluster::TerminationProtectedHasBeenSet ( ) const
inline

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Definition at line 570 of file Cluster.h.

◆ VisibleToAllUsersHasBeenSet()

bool Aws::EMR::Model::Cluster::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 on the cluster 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 allowed 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 627 of file Cluster.h.

◆ WithApplications() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithApplications ( Aws::Vector< Application > &&  value)
inline

The applications installed on this cluster.

Definition at line 700 of file Cluster.h.

◆ WithApplications() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithApplications ( const Aws::Vector< Application > &  value)
inline

The applications installed on this cluster.

Definition at line 695 of file Cluster.h.

◆ WithAutoScalingRole() [1/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1037 of file Cluster.h.

◆ WithAutoScalingRole() [2/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1029 of file Cluster.h.

◆ WithAutoScalingRole() [3/3]

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

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Definition at line 1045 of file Cluster.h.

◆ WithAutoTerminate()

Cluster& Aws::EMR::Model::Cluster::WithAutoTerminate ( bool  value)
inline

Specifies whether the cluster should terminate after completing all steps.

Definition at line 555 of file Cluster.h.

◆ WithClusterArn() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1354 of file Cluster.h.

◆ WithClusterArn() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithClusterArn ( const Aws::String value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1349 of file Cluster.h.

◆ WithClusterArn() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithClusterArn ( const char *  value)
inline

The Amazon Resource Name of the cluster.

Definition at line 1359 of file Cluster.h.

◆ WithConfigurations() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithConfigurations ( Aws::Vector< Configuration > &&  value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 927 of file Cluster.h.

◆ WithConfigurations() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithConfigurations ( const Aws::Vector< Configuration > &  value)
inline

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

Definition at line 921 of file Cluster.h.

◆ WithCustomAmiId() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithCustomAmiId ( Aws::String &&  value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1191 of file Cluster.h.

◆ WithCustomAmiId() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithCustomAmiId ( const Aws::String value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1185 of file Cluster.h.

◆ WithCustomAmiId() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithCustomAmiId ( const char *  value)
inline

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

Definition at line 1197 of file Cluster.h.

◆ WithEbsRootVolumeSize()

Cluster& Aws::EMR::Model::Cluster::WithEbsRootVolumeSize ( int  value)
inline

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Definition at line 1226 of file Cluster.h.

◆ WithEc2InstanceAttributes() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithEc2InstanceAttributes ( const Ec2InstanceAttributes value)
inline

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

Definition at line 192 of file Cluster.h.

◆ WithEc2InstanceAttributes() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithEc2InstanceAttributes ( Ec2InstanceAttributes &&  value)
inline

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

Definition at line 198 of file Cluster.h.

◆ WithId() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithId ( Aws::String &&  value)
inline

The unique identifier for the cluster.

Definition at line 84 of file Cluster.h.

◆ WithId() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithId ( const Aws::String value)
inline

The unique identifier for the cluster.

Definition at line 79 of file Cluster.h.

◆ WithId() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithId ( const char *  value)
inline

The unique identifier for the cluster.

Definition at line 89 of file Cluster.h.

◆ WithInstanceCollectionType() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithInstanceCollectionType ( const InstanceCollectionType value)
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 244 of file Cluster.h.

◆ WithInstanceCollectionType() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithInstanceCollectionType ( InstanceCollectionType &&  value)
inline

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

Definition at line 253 of file Cluster.h.

◆ WithKerberosAttributes() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithKerberosAttributes ( const KerberosAttributes value)
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1310 of file Cluster.h.

◆ WithKerberosAttributes() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithKerberosAttributes ( KerberosAttributes &&  value)
inline

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

Definition at line 1318 of file Cluster.h.

◆ WithLogEncryptionKmsKeyId() [1/3]

Cluster& Aws::EMR::Model::Cluster::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 345 of file Cluster.h.

◆ WithLogEncryptionKmsKeyId() [2/3]

Cluster& Aws::EMR::Model::Cluster::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 339 of file Cluster.h.

◆ WithLogEncryptionKmsKeyId() [3/3]

Cluster& Aws::EMR::Model::Cluster::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 351 of file Cluster.h.

◆ WithLogUri() [1/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 296 of file Cluster.h.

◆ WithLogUri() [2/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 290 of file Cluster.h.

◆ WithLogUri() [3/3]

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

The path to the Amazon S3 location where logs for this cluster are stored.

Definition at line 302 of file Cluster.h.

◆ WithMasterPublicDnsName() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithMasterPublicDnsName ( Aws::String &&  value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 884 of file Cluster.h.

◆ WithMasterPublicDnsName() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithMasterPublicDnsName ( const Aws::String value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 878 of file Cluster.h.

◆ WithMasterPublicDnsName() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithMasterPublicDnsName ( const char *  value)
inline

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

Definition at line 890 of file Cluster.h.

◆ WithName() [1/3]

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

The name of the cluster.

Definition at line 125 of file Cluster.h.

◆ WithName() [2/3]

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

The name of the cluster.

Definition at line 120 of file Cluster.h.

◆ WithName() [3/3]

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

The name of the cluster.

Definition at line 130 of file Cluster.h.

◆ WithNormalizedInstanceHours()

Cluster& Aws::EMR::Model::Cluster::WithNormalizedInstanceHours ( int  value)
inline

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

Definition at line 841 of file Cluster.h.

◆ WithOutpostArn() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithOutpostArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1402 of file Cluster.h.

◆ WithOutpostArn() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithOutpostArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1396 of file Cluster.h.

◆ WithOutpostArn() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithOutpostArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Definition at line 1408 of file Cluster.h.

◆ WithPlacementGroups() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithPlacementGroups ( Aws::Vector< PlacementGroupConfig > &&  value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1460 of file Cluster.h.

◆ WithPlacementGroups() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithPlacementGroups ( const Aws::Vector< PlacementGroupConfig > &  value)
inline

Placement group configured for an Amazon EMR cluster.

Definition at line 1455 of file Cluster.h.

◆ WithReleaseLabel() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithReleaseLabel ( Aws::String &&  value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 518 of file Cluster.h.

◆ WithReleaseLabel() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithReleaseLabel ( const Aws::String value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 506 of file Cluster.h.

◆ WithReleaseLabel() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithReleaseLabel ( const char *  value)
inline

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Definition at line 530 of file Cluster.h.

◆ WithRepoUpgradeOnBoot() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithRepoUpgradeOnBoot ( const RepoUpgradeOnBoot value)
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1262 of file Cluster.h.

◆ WithRepoUpgradeOnBoot() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithRepoUpgradeOnBoot ( RepoUpgradeOnBoot &&  value)
inline

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

Definition at line 1269 of file Cluster.h.

◆ WithRequestedAmiVersion() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithRequestedAmiVersion ( Aws::String &&  value)
inline

The AMI version requested for this cluster.

Definition at line 387 of file Cluster.h.

◆ WithRequestedAmiVersion() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithRequestedAmiVersion ( const Aws::String value)
inline

The AMI version requested for this cluster.

Definition at line 382 of file Cluster.h.

◆ WithRequestedAmiVersion() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithRequestedAmiVersion ( const char *  value)
inline

The AMI version requested for this cluster.

Definition at line 392 of file Cluster.h.

◆ WithRunningAmiVersion() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithRunningAmiVersion ( Aws::String &&  value)
inline

The AMI version running on this cluster.

Definition at line 428 of file Cluster.h.

◆ WithRunningAmiVersion() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithRunningAmiVersion ( const Aws::String value)
inline

The AMI version running on this cluster.

Definition at line 423 of file Cluster.h.

◆ WithRunningAmiVersion() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithRunningAmiVersion ( const char *  value)
inline

The AMI version running on this cluster.

Definition at line 433 of file Cluster.h.

◆ WithScaleDownBehavior() [1/2]

Cluster& Aws::EMR::Model::Cluster::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 is 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 1131 of file Cluster.h.

◆ WithScaleDownBehavior() [2/2]

Cluster& Aws::EMR::Model::Cluster::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 is 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 1148 of file Cluster.h.

◆ WithSecurityConfiguration() [1/3]

Cluster& Aws::EMR::Model::Cluster::WithSecurityConfiguration ( Aws::String &&  value)
inline

The name of the security configuration applied to the cluster.

Definition at line 975 of file Cluster.h.

◆ WithSecurityConfiguration() [2/3]

Cluster& Aws::EMR::Model::Cluster::WithSecurityConfiguration ( const Aws::String value)
inline

The name of the security configuration applied to the cluster.

Definition at line 970 of file Cluster.h.

◆ WithSecurityConfiguration() [3/3]

Cluster& Aws::EMR::Model::Cluster::WithSecurityConfiguration ( const char *  value)
inline

The name of the security configuration applied to the cluster.

Definition at line 980 of file Cluster.h.

◆ WithServiceRole() [1/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 794 of file Cluster.h.

◆ WithServiceRole() [2/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 788 of file Cluster.h.

◆ WithServiceRole() [3/3]

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

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

Definition at line 800 of file Cluster.h.

◆ WithStatus() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithStatus ( ClusterStatus &&  value)
inline

The current status details about the cluster.

Definition at line 161 of file Cluster.h.

◆ WithStatus() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithStatus ( const ClusterStatus value)
inline

The current status details about the cluster.

Definition at line 156 of file Cluster.h.

◆ WithStepConcurrencyLevel()

Cluster& Aws::EMR::Model::Cluster::WithStepConcurrencyLevel ( int  value)
inline

Specifies the number of steps that can be executed concurrently.

Definition at line 1429 of file Cluster.h.

◆ WithTags() [1/2]

Cluster& Aws::EMR::Model::Cluster::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags associated with a cluster.

Definition at line 741 of file Cluster.h.

◆ WithTags() [2/2]

Cluster& Aws::EMR::Model::Cluster::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags associated with a cluster.

Definition at line 736 of file Cluster.h.

◆ WithTerminationProtected()

Cluster& Aws::EMR::Model::Cluster::WithTerminationProtected ( bool  value)
inline

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

Definition at line 584 of file Cluster.h.

◆ WithVisibleToAllUsers()

Cluster& Aws::EMR::Model::Cluster::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 on the cluster 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 allowed 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 669 of file Cluster.h.


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