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

Class: Aws::ECS::Types::ContainerOverride

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ContainerOverride as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String",
  command: ["String"],
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  environment_files: [
    {
      value: "String", # required
      type: "s3", # required, accepts s3
    },
  ],
  cpu: 1,
  memory: 1,
  memory_reservation: 1,
  resource_requirements: [
    {
      value: "String", # required
      type: "GPU", # required, accepts GPU, InferenceAccelerator
    },
  ],
}

The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#command ⇒ Array<String>

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

Returns:

  • (Array<String>) —

    The command to send to the container that overrides the default command from the Docker image or the task definition.

#cpu ⇒ Integer

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

Returns:

  • (Integer) —

    The number of cpu units reserved for the container, instead of the default value from the task definition.

#environment ⇒ Array<Types::KeyValuePair>

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Returns:

#environment_files ⇒ Array<Types::EnvironmentFile>

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

Returns:

  • (Array<Types::EnvironmentFile>) —

    A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

#memory ⇒ Integer

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

Returns:

  • (Integer) —

    The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.

#memory_reservation ⇒ Integer

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

Returns:

  • (Integer) —

    The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.

#name ⇒ String

The name of the container that receives the override. This parameter is required if any override is specified.

Returns:

  • (String) —

    The name of the container that receives the override.

#resource_requirements ⇒ Array<Types::ResourceRequirement>

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

Returns:

  • (Array<Types::ResourceRequirement>) —

    The type and amount of a resource to assign to a container, instead of the default value from the task definition.