Struct aws_sdk_emr::model::Cluster

source · [−]

#[non_exhaustive]
pub struct Cluster {Show 30 fields
    pub id: Option<String>,
    pub name: Option<String>,
    pub status: Option<ClusterStatus>,
    pub ec2_instance_attributes: Option<Ec2InstanceAttributes>,
    pub instance_collection_type: Option<InstanceCollectionType>,
    pub log_uri: Option<String>,
    pub log_encryption_kms_key_id: Option<String>,
    pub requested_ami_version: Option<String>,
    pub running_ami_version: Option<String>,
    pub release_label: Option<String>,
    pub auto_terminate: bool,
    pub termination_protected: bool,
    pub visible_to_all_users: bool,
    pub applications: Option<Vec<Application>>,
    pub tags: Option<Vec<Tag>>,
    pub service_role: Option<String>,
    pub normalized_instance_hours: Option<i32>,
    pub master_public_dns_name: Option<String>,
    pub configurations: Option<Vec<Configuration>>,
    pub security_configuration: Option<String>,
    pub auto_scaling_role: Option<String>,
    pub scale_down_behavior: Option<ScaleDownBehavior>,
    pub custom_ami_id: Option<String>,
    pub ebs_root_volume_size: Option<i32>,
    pub repo_upgrade_on_boot: Option<RepoUpgradeOnBoot>,
    pub kerberos_attributes: Option<KerberosAttributes>,
    pub cluster_arn: Option<String>,
    pub outpost_arn: Option<String>,
    pub step_concurrency_level: Option<i32>,
    pub placement_groups: Option<Vec<PlacementGroupConfig>>,
}

Expand description

The detailed description of the cluster.

Fields (Non-exhaustive)

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The unique identifier for the cluster.

name: Option<String>

The name of the cluster.

status: Option<ClusterStatus>

The current status details about the cluster.

ec2_instance_attributes: Option<Ec2InstanceAttributes>

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

instance_collection_type: Option<InstanceCollectionType>

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.

log_uri: Option<String>

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

log_encryption_kms_key_id: Option<String>

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.

requested_ami_version: Option<String>

The AMI version requested for this cluster.

running_ami_version: Option<String>

The AMI version running on this cluster.

release_label: Option<String>

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.

auto_terminate: bool

Specifies whether the cluster should terminate after completing all steps.

termination_protected: bool

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.

visible_to_all_users: bool

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.

applications: Option<Vec<Application>>

The applications installed on this cluster.

tags: Option<Vec<Tag>>

A list of tags associated with a cluster.

service_role: Option<String>

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

normalized_instance_hours: Option<i32>

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.

master_public_dns_name: Option<String>

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.

configurations: Option<Vec<Configuration>>

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

security_configuration: Option<String>

The name of the security configuration applied to the cluster.

auto_scaling_role: Option<String>

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.

scale_down_behavior: Option<ScaleDownBehavior>

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR 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.

custom_ami_id: Option<String>

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.

ebs_root_volume_size: Option<i32>

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.

repo_upgrade_on_boot: Option<RepoUpgradeOnBoot>

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.

kerberos_attributes: Option<KerberosAttributes>

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.

cluster_arn: Option<String>

The Amazon Resource Name of the cluster.

outpost_arn: Option<String>

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

step_concurrency_level: Option<i32>

Specifies the number of steps that can be executed concurrently.

placement_groups: Option<Vec<PlacementGroupConfig>>

Placement group configured for an Amazon EMR cluster.

Struct aws_sdk_emr::model::Cluster

Fields (Non-exhaustive)

Implementations

impl Cluster

pub fn id(&self) -> Option<&str>

pub fn name(&self) -> Option<&str>

pub fn status(&self) -> Option<&ClusterStatus>

pub fn ec2_instance_attributes(&self) -> Option<&Ec2InstanceAttributes>

pub fn instance_collection_type(&self) -> Option<&InstanceCollectionType>

pub fn log_uri(&self) -> Option<&str>

pub fn log_encryption_kms_key_id(&self) -> Option<&str>

pub fn requested_ami_version(&self) -> Option<&str>

pub fn running_ami_version(&self) -> Option<&str>

pub fn release_label(&self) -> Option<&str>

pub fn auto_terminate(&self) -> bool

pub fn termination_protected(&self) -> bool

pub fn visible_to_all_users(&self) -> bool

pub fn applications(&self) -> Option<&[Application]>

pub fn tags(&self) -> Option<&[Tag]>

pub fn service_role(&self) -> Option<&str>

pub fn normalized_instance_hours(&self) -> Option<i32>

pub fn master_public_dns_name(&self) -> Option<&str>

pub fn configurations(&self) -> Option<&[Configuration]>

pub fn security_configuration(&self) -> Option<&str>

pub fn auto_scaling_role(&self) -> Option<&str>

pub fn scale_down_behavior(&self) -> Option<&ScaleDownBehavior>

pub fn custom_ami_id(&self) -> Option<&str>

pub fn ebs_root_volume_size(&self) -> Option<i32>

pub fn repo_upgrade_on_boot(&self) -> Option<&RepoUpgradeOnBoot>

pub fn kerberos_attributes(&self) -> Option<&KerberosAttributes>

pub fn cluster_arn(&self) -> Option<&str>

pub fn outpost_arn(&self) -> Option<&str>

pub fn step_concurrency_level(&self) -> Option<i32>

pub fn placement_groups(&self) -> Option<&[PlacementGroupConfig]>

impl Cluster

pub fn builder() -> Builder

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

fn clone_from(&mut self, source: &Self)

impl Debug for Cluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq<Cluster> for Cluster

fn eq(&self, other: &Cluster) -> bool

fn ne(&self, other: &Cluster) -> bool

impl StructuralPartialEq for Cluster

Auto Trait Implementations

impl RefUnwindSafe for Cluster

impl Send for Cluster

impl Sync for Cluster

impl Unpin for Cluster

impl UnwindSafe for Cluster

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn applications(&self) -> Option<&[Application ]>

pub fn tags(&self) -> Option<&[Tag ]>

pub fn configurations(&self) -> Option<&[Configuration ]>

pub fn placement_groups(&self) -> Option<&[PlacementGroupConfig ]>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,