Class: Aws::Batch::Types::ContainerDetail

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

Overview

An object that represents the details of a container that’s part of a job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command that’s passed to the container.

Returns:

  • (Array<String>)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#container_instance_arnString

The Amazon Resource Name (ARN) of the container instance that the container is running on.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environmentArray<Types::KeyValuePair>

The environment variables to pass to a container.

<note markdown=“1”> Environment variables cannot start with “‘AWS_BATCH`”. This naming convention is reserved for variables that Batch sets.

</note>

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storageTypes::EphemeralStorage

The amount of ephemeral storage allocated 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.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

The Amazon Resource Name (ARN) of the execution role that Batch can assume. 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)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#exit_codeInteger

The exit code returned upon completion.

Returns:

  • (Integer)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#fargate_platform_configurationTypes::FargatePlatformConfiguration

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



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#imageString

The image used to start the container.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type of the underlying host infrastructure of a multi-node parallel job.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources.

</note>

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#job_role_arnString

The Amazon Resource Name (ARN) that’s associated with the job when run.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#linux_parametersTypes::LinuxParameters

Linux-specific modifications that are applied to the container, such as details for device mappings.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#log_configurationTypes::LogConfiguration

The log configuration specification for the container.

This parameter maps to ‘LogConfig` in the [Create a container] section of the [Docker Remote API] and the `–log-driver` option to [docker run]. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see [Configure logging drivers] in the Docker documentation.

<note markdown=“1”> Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration] data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

</note>

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ‘sudo docker version | grep “Server API version”`

<note markdown=“1”> The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ‘ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration] in the *Amazon Elastic Container Service Developer Guide*.

</note>

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/run/ [4]: docs.docker.com/engine/admin/logging/overview/ [5]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties-logconfiguration.html [6]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#log_stream_nameString

The name of the Amazon CloudWatch Logs log stream that’s associated with the container. The log group for Batch jobs is ‘/aws/batch/job`. Each container attempt receives a log stream name when they reach the `RUNNING` status.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#memoryInteger

For jobs running on Amazon EC2 resources that didn’t specify memory requirements using ‘resourceRequirements`, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see `resourceRequirements`.

Returns:

  • (Integer)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#mount_pointsArray<Types::MountPoint>

The mount points for data volumes in your container.

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::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.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#network_interfacesArray<Types::NetworkInterface>

The network interfaces that are associated with the job.

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#privilegedBoolean

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the ‘root` user). The default value is `false`.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources and shouldn’t be provided, or specified as ‘false`.

</note>

Returns:

  • (Boolean)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#readonly_root_filesystemBoolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ‘ReadonlyRootfs` in the [Create a container] section of the [Docker Remote API] and the `–read-only` option to [ `docker run` ][3].

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/commandline/run/

Returns:

  • (Boolean)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#reasonString

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#repository_credentialsTypes::RepositoryCredentials

The private repository authentication credentials to use.



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#resource_requirementsArray<Types::ResourceRequirement>

The type and amount of resources to assign to a container. The supported resources include ‘GPU`, `MEMORY`, and `VCPU`.

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_platformTypes::RuntimePlatform

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



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#secretsArray<Types::Secret>

The secrets to pass to the container. For more information, see

Specifying sensitive data][1

in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

The Amazon Resource Name (ARN) of the Amazon ECS task that’s associated with the container job. Each container attempt receives a task ARN when they reach the ‘STARTING` status.

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#ulimitsArray<Types::Ulimit>

A list of ‘ulimit` values to set in the container. This parameter maps to `Ulimits` in the [Create a container] section of the

Docker Remote API][2

and the ‘–ulimit` option to [docker run].

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources.

</note>

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/run/

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#userString

The user name to use inside the container. This parameter maps to ‘User` in the [Create a container] section of the [Docker Remote API] and the `–user` option to [docker run].

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (String)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#vcpusInteger

The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can specify the vCPU requirement for the job using ‘resourceRequirements`, but you can’t specify the vCPU requirements in both the ‘vcpus` and `resourceRequirements` object. This parameter maps to `CpuShares` in the [Create a container] section of the [Docker Remote API] and the `–cpu-shares` option to [docker run]. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

<note markdown=“1”> This parameter isn’t applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using ‘resourceRequirements`.

</note>

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/run/

Returns:

  • (Integer)


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end

#volumesArray<Types::Volume>

A list of volumes that are associated with the job.

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
# File 'lib/aws-sdk-batch/types.rb', line 1594

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :execution_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name,
  :instance_type,
  :network_interfaces,
  :resource_requirements,
  :linux_parameters,
  :log_configuration,
  :secrets,
  :network_configuration,
  :fargate_platform_configuration,
  :ephemeral_storage,
  :runtime_platform,
  :repository_credentials)
  SENSITIVE = []
  include Aws::Structure
end