AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GlueDataBrew::Types::CreateRecipeJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateRecipeJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  dataset_name: "DatasetName",
  encryption_key_arn: "EncryptionKeyArn",
  encryption_mode: "SSE-KMS", # accepts SSE-KMS, SSE-S3
  name: "JobName", # required
  log_subscription: "ENABLE", # accepts ENABLE, DISABLE
  max_capacity: 1,
  max_retries: 1,
  outputs: [ # required
    {
      compression_format: "GZIP", # accepts GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB
      format: "CSV", # accepts CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML
      partition_columns: ["ColumnName"],
      location: { # required
        bucket: "Bucket", # required
        key: "Key",
      },
      overwrite: false,
    },
  ],
  project_name: "ProjectName",
  recipe_reference: {
    name: "RecipeName", # required
    recipe_version: "RecipeVersion",
  },
  role_arn: "Arn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  timeout: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dataset_nameString

The name of the dataset that this job processes.

Returns:

  • (String)

    The name of the dataset that this job processes.

#encryption_key_arnString

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

#encryption_modeString

The encryption mode for the job, which can be one of the following:

  • SSE-KMS - Server-side encryption with AWS KMS-managed keys.

  • SSE-S3 - Server-side encryption with keys managed by Amazon S3.

    Possible values:

    • SSE-KMS
    • SSE-S3

Returns:

  • (String)

    The encryption mode for the job, which can be one of the following:.

#log_subscriptionString

A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.

Possible values:

  • ENABLE
  • DISABLE

Returns:

  • (String)

    A value that enables or disables Amazon CloudWatch logging for the current AWS account.

#max_capacityInteger

The maximum number of nodes that DataBrew can consume when the job processes data.

Returns:

  • (Integer)

    The maximum number of nodes that DataBrew can consume when the job processes data.

#max_retriesInteger

The maximum number of times to retry the job after a job run fails.

Returns:

  • (Integer)

    The maximum number of times to retry the job after a job run fails.

#nameString

A unique name for the job.

Returns:

  • (String)

    A unique name for the job.

#outputsArray<Types::Output>

One or more artifacts that represent the output from running the job.

Returns:

  • (Array<Types::Output>)

    One or more artifacts that represent the output from running the job.

#project_nameString

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

Returns:

  • (String)

    Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

#recipe_referenceTypes::RecipeReference

Represents all of the attributes of an AWS Glue DataBrew recipe.

Returns:

#role_arnString

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.

#tagsHash<String,String>

Metadata tags to apply to this job dataset.

Returns:

  • (Hash<String,String>)

    Metadata tags to apply to this job dataset.

#timeoutInteger

The job\'s timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Returns:

  • (Integer)

    The job\'s timeout in minutes.