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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ContainerOverride

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

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

You can use Secrets Manager or Amazon Web Services Systems Manager Parameter Store to store the sensitive data. For more information, see

Retrieve secrets through environment variables][1

in the Amazon ECS

Developer Guide.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command ⇒ 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.

• #environment ⇒ Array<Types::KeyValuePair>

  The environment variables to send to the container.

• #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.

• #memory ⇒ 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.

• #name ⇒ 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.

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

• (Array<Types::KeyValuePair>)

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-ecs/types.rb', line 2282

class ContainerOverride < Struct.new(
  :name,
  :command,
  :environment,
  :environment_files,
  :cpu,
  :memory,
  :memory_reservation,
  :resource_requirements)
  SENSITIVE = []
  include Aws::Structure
end