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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command that is passed to the container.

Returns:

  • (Array<String>)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#container_instance_arnString

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

Returns:

  • (String)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#environmentArray<Types::KeyValuePair>

The environment variables to pass to a container.

Returns:



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#exit_codeInteger

The exit code to return upon completion.

Returns:

  • (Integer)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#imageString

The image used to start the container.

Returns:

  • (String)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#job_role_arnString

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

Returns:

  • (String)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  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)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#memoryInteger

The number of MiB of memory reserved for the job.

Returns:

  • (Integer)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#mount_pointsArray<Types::MountPoint>

The mount points for data volumes in your container.

Returns:



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  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)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  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)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  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)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#task_arnString

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.

Returns:

  • (String)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#ulimitsArray<Types::Ulimit>

A list of ulimit values to set in the container.

Returns:



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#userString

The user name to use inside the container.

Returns:

  • (String)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#vcpusInteger

The number of VCPUs allocated for the job.

Returns:

  • (Integer)


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end

#volumesArray<Types::Volume>

A list of volumes associated with the job.

Returns:



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 433

class ContainerDetail < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :ulimits,
  :privileged,
  :user,
  :exit_code,
  :reason,
  :container_instance_arn,
  :task_arn,
  :log_stream_name)
  include Aws::Structure
end