Struct aws_sdk_emr::input::RunJobFlowInput

#[non_exhaustive]
pub struct RunJobFlowInput { /* private fields */ }

Input to the RunJobFlow operation.

Implementations

impl RunJobFlowInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<RunJobFlow, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<RunJobFlow>

Examples found in repository

src/client.rs (line 5043)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::RunJobFlow,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::RunJobFlowError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::RunJobFlowOutput,
            aws_smithy_http::result::SdkError<crate::error::RunJobFlowError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RunJobFlowInput.

impl RunJobFlowInput

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

The name of the job flow.

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

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

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

The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.

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

A JSON string for selecting additional features.

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 release_label(&self) -> Option<&str>

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.

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

A specification of the number and type of Amazon EC2 instances.

pub fn steps(&self) -> Option<&[StepConfig]>

A list of steps to run.

pub fn bootstrap_actions(&self) -> Option<&[BootstrapActionConfig]>

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

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

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

• "mapr-m3" - launch the job flow using MapR M3 Edition.

• "mapr-m5" - launch the job flow using MapR M5 Edition.

pub fn new_supported_products(&self) -> Option<&[SupportedProductConfig]>

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distribution for Hadoop" in the Amazon EMR Developer Guide. Supported values are:

• "mapr-m3" - launch the cluster using MapR M3 Edition.

• "mapr-m5" - launch the cluster using MapR M5 Edition.

• "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or M5 Edition respectively.

• "mapr-m7" - launch the cluster using MapR M7 Edition.

• "hunk" - launch the cluster with the Hunk Big Data Analytics Platform.

• "hue"- launch the cluster with Hue installed.

• "spark" - launch the cluster with Apache Spark installed.

• "ganglia" - launch the cluster with the Ganglia Monitoring System installed.

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

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMRRelease Guide.

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

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

pub fn visible_to_all_users(&self) -> bool

The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

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

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

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

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

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

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

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

The name of a security configuration to apply to the cluster.

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 permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

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

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

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

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

pub fn ebs_root_volume_size(&self) -> 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.

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

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

pub fn kerberos_attributes(&self) -> 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.

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

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

pub fn managed_scaling_policy(&self) -> Option<&ManagedScalingPolicy>

The specified managed scaling policy for an Amazon EMR cluster.

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

The specified placement group configuration for an Amazon EMR cluster.

pub fn auto_termination_policy(&self) -> Option<&AutoTerminationPolicy>

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

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

Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.

Trait Implementations

impl Clone for RunJobFlowInput

fn clone(&self) -> RunJobFlowInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunJobFlowInput

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

Formats the value using the given formatter.

impl PartialEq<RunJobFlowInput> for RunJobFlowInput

fn eq(&self, other: &RunJobFlowInput) -> 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 RunJobFlowInput