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

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

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

Overview

Note:

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

{
  name: "String",
  command: ["String"],
  environment: [
    {
      name: "String",
      value: "String",
    },
  ],
  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.

Instance Attribute Summary collapse

Instance Attribute Details

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


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

#cpuInteger

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)


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

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



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

#memoryInteger

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)


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

#memory_reservationInteger

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)


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

#nameString

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

Returns:

  • (String)


1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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

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



1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 1768

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