Class: Aws::Batch::Types::EcsTaskProperties

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#containers ⇒ Array<Types::TaskContainerProperties>

This object is a list of containers.

Returns:



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storage ⇒ Types::EphemeralStorage

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

Returns:



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see [Batch execution IAM role] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html

Returns:

  • (String) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#ipc_mode ⇒ String

The IPC resource namespace to use for the containers in the task. The valid values are ‘host`, `task`, or `none`.

If ‘host` is specified, all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If ‘task` is specified, all containers within the specified `task` share the same IPC resources.

If ‘none` is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings] in the Docker run reference.

[1]: docs.docker.com/engine/reference/run/#ipc-settings—ipc

Returns:

  • (String) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#network_configuration ⇒ Types::NetworkConfiguration

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Returns:



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#pid_mode ⇒ String

The process namespace to use for the containers in the task. The valid values are ‘host` or `task`. For example, monitoring sidecars might need `pidMode` to access information about other containers running in the same task.

If ‘host` is specified, all containers within the tasks that specified the `host` PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If ‘task` is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see [PID settings] in the Docker run reference.

[1]: docs.docker.com/engine/reference/run/#pid-settings—pid

Returns:

  • (String) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ String

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn’t specified, the ‘LATEST` platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see [Fargate platform versions] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html

Returns:

  • (String) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_platform ⇒ Types::RuntimePlatform

An object that represents the compute environment architecture for Batch jobs on Fargate.

Returns:



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#task_role_arn ⇒ String

The Amazon Resource Name (ARN) that’s associated with the Amazon ECS task.

<note markdown=“1”> This is object is comparable to [ContainerProperties:jobRoleArn].

</note>

[1]: docs.aws.amazon.com/batch/latest/APIReference/API_ContainerProperties.html

Returns:

  • (String) 


3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#volumes ⇒ Array<Types::Volume>

A list of volumes that are associated with the job.

Returns:



3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/aws-sdk-batch/types.rb', line 3288

class EcsTaskProperties < Struct.new(
  :containers,
  :ephemeral_storage,
  :execution_role_arn,
  :platform_version,
  :ipc_mode,
  :task_role_arn,
  :pid_mode,
  :network_configuration,
  :runtime_platform,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end