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

Class: Aws::Batch::Types::ContainerProperties

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

Overview

Note:

When making an API call, you may pass ContainerProperties data as a hash:

{
  image: "String", # required
  vcpus: 1, # required
  memory: 1, # required
  command: ["String"],
  job_role_arn: "String",
  volumes: [
    {
      host: {
        source_path: "String",
      },
      name: "String",
    },
  ],
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  mount_points: [
    {
      container_path: "String",
      read_only: false,
      source_volume: "String",
    },
  ],
  readonly_root_filesystem: false,
  privileged: false,
  ulimits: [
    {
      hard_limit: 1, # required
      name: "String", # required
      soft_limit: 1, # required
    },
  ],
  user: "String",
}

Container properties are used in job definitions to describe the container that is launched as part of a job.

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

Returns:

  • (Array<String>)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#environmentArray<Types::KeyValuePair>

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plain text environment variables for sensitive information, such as credential data.

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#imageString

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Returns:

  • (String)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#job_role_arnString

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

Returns:

  • (String)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#memoryInteger

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

Returns:

  • (Integer)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#mount_pointsArray<Types::MountPoint>

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  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). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

Returns:

  • (Boolean)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

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

Returns:

  • (Boolean)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#ulimitsArray<Types::Ulimit>

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

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

Returns:

  • (String)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#vcpusInteger

The number of vCPUs reserved for the container. 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.

Returns:

  • (Integer)


691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end

#volumesArray<Types::Volume>

A list of data volumes used in a job.

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 691

class ContainerProperties < Struct.new(
  :image,
  :vcpus,
  :memory,
  :command,
  :job_role_arn,
  :volumes,
  :environment,
  :mount_points,
  :readonly_root_filesystem,
  :privileged,
  :ulimits,
  :user)
  include Aws::Structure
end