Struct aws_sdk_emr::types::JobFlowDetail

#[non_exhaustive]
pub struct JobFlowDetail {

    pub job_flow_id: Option<String>,
    pub name: Option<String>,
    pub log_uri: Option<String>,
    pub log_encryption_kms_key_id: Option<String>,
    pub ami_version: Option<String>,
    pub execution_status_detail: Option<JobFlowExecutionStatusDetail>,
    pub instances: Option<JobFlowInstancesDetail>,
    pub steps: Option<Vec<StepDetail>>,
    pub bootstrap_actions: Option<Vec<BootstrapActionDetail>>,
    pub supported_products: Option<Vec<String>>,
    pub visible_to_all_users: Option<bool>,
    pub job_flow_role: Option<String>,
    pub service_role: Option<String>,
    pub auto_scaling_role: Option<String>,
    pub scale_down_behavior: Option<ScaleDownBehavior>,
}

A description of a cluster (job flow).

Fields (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.

job_flow_id: Option<String>

The job flow identifier.

name: Option<String>

The name of the job flow.

log_uri: Option<String>

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

log_encryption_kms_key_id: Option<String>

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

ami_version: Option<String>

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.

execution_status_detail: Option<JobFlowExecutionStatusDetail>

Describes the execution status of the job flow.

instances: Option<JobFlowInstancesDetail>

Describes the Amazon EC2 instances of the job flow.

steps: Option<Vec<StepDetail>>

A list of steps run by the job flow.

bootstrap_actions: Option<Vec<BootstrapActionDetail>>

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

supported_products: Option<Vec<String>>

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.

visible_to_all_users: Option<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 Amazon 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 Amazon 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 Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.

job_flow_role: Option<String>

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

service_role: Option<String>

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

auto_scaling_role: Option<String>

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 Amazon 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 available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.

Implementations

impl JobFlowDetail

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

The job flow identifier.

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

The name of the job flow.

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

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

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

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

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

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.

pub fn execution_status_detail(&self) -> Option<&JobFlowExecutionStatusDetail>

Describes the execution status of the job flow.

pub fn instances(&self) -> Option<&JobFlowInstancesDetail>

Describes the Amazon EC2 instances of the job flow.

pub fn steps(&self) -> &[StepDetail]

A list of steps run by the job flow.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .steps.is_none().

pub fn bootstrap_actions(&self) -> &[BootstrapActionDetail]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .bootstrap_actions.is_none().

pub fn supported_products(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_products.is_none().

pub fn visible_to_all_users(&self) -> Option<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 Amazon 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 Amazon 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 Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.

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

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

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

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

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

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 Amazon EC2 instances in an instance group.

pub fn scale_down_behavior(&self) -> 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 available only in Amazon EMR releases 4.1.0 and later, and is the default for releases of Amazon EMR earlier than 5.1.0.

impl JobFlowDetail

pub fn builder() -> JobFlowDetailBuilder

Creates a new builder-style object to manufacture JobFlowDetail.

Trait Implementations

impl Clone for JobFlowDetail

fn clone(&self) -> JobFlowDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobFlowDetail

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

Formats the value using the given formatter.

impl PartialEq for JobFlowDetail

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JobFlowDetail