Class: Aws::Pipes::Types::PipeTargetBatchJobParameters

Inherits:

Struct

• Object
• Struct
• Aws::Pipes::Types::PipeTargetBatchJobParameters

Includes:

Structure

Defined in:

lib/aws-sdk-pipes/types.rb

Overview

The parameters for using an Batch job as a target.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #array_properties ⇒ Types::BatchArrayProperties

  The array properties for the submitted job, such as the size of the array.

• #container_overrides ⇒ Types::BatchContainerOverrides

  The overrides that are sent to a container.

• #depends_on ⇒ Array<Types::BatchJobDependency>

  A list of dependencies for the job.

• #job_definition ⇒ String

  The job definition used by this job.

• #job_name ⇒ String

  The name of the job.

• #parameters ⇒ Hash<String,String>

  Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.

• #retry_strategy ⇒ Types::BatchRetryStrategy

  The retry strategy to use for failed jobs.

Instance Attribute Details

#array_properties ⇒ Types::BatchArrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

Returns:

• (Types::BatchArrayProperties)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#container_overrides ⇒ Types::BatchContainerOverrides

The overrides that are sent to a container.

Returns:

• (Types::BatchContainerOverrides)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#depends_on ⇒ Array<Types::BatchJobDependency>

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a ‘SEQUENTIAL` type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an `N_TO_N` type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Returns:

• (Array<Types::BatchJobDependency>)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_definition ⇒ String

The job definition used by this job. This value can be one of ‘name`, `name:revision`, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Returns:

• (String)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end

#retry_strategy ⇒ Types::BatchRetryStrategy

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

Returns:

• (Types::BatchRetryStrategy)

# File 'lib/aws-sdk-pipes/types.rb', line 2138

class PipeTargetBatchJobParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy,
  :container_overrides,
  :depends_on,
  :parameters)
  SENSITIVE = []
  include Aws::Structure
end