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

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

Overview

An object representing the details of a container that is part of a job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command that is passed to the container.

Returns:

  • (Array<String>)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#container_instance_arnString

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

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#environmentArray<Types::KeyValuePair>

The environment variables to pass to a container.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see Amazon ECS task execution IAM role.

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#exit_codeInteger

The exit code to return upon completion.

Returns:

  • (Integer)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#imageString

The image used to start the container.

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#job_role_arnString

The Amazon Resource Name (ARN) associated with the job upon execution.

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#linux_parametersTypes::LinuxParameters

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



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  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 may 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 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.

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

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 into your container instance and run the following command: sudo docker version | grep "Server API version"

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.



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#log_stream_nameString

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

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#memoryInteger

The number of MiB of memory reserved for the job.

Returns:

  • (Integer)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#mount_pointsArray<Types::MountPoint>

The mount points for data volumes in your container.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#network_interfacesArray<Types::NetworkInterface>

The network interfaces associated with the job.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#privilegedBoolean

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

Returns:

  • (Boolean)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  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.

Returns:

  • (Boolean)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#reasonString

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

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_requirementsArray<Types::ResourceRequirement>

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#secretsArray<Types::Secret>

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

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

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#ulimitsArray<Types::Ulimit>

A list of ulimit values to set in the container.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#userString

The user name to use inside the container.

Returns:

  • (String)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#vcpusInteger

The number of VCPUs allocated for the job.

Returns:

  • (Integer)


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end

#volumesArray<Types::Volume>

A list of volumes associated with the job.

Returns:



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 734

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)
  SENSITIVE = []
  include Aws::Structure
end