Class CfnPipe.EcsContainerOverrideProperty

The overrides that are sent to a container.

Inheritance

object

CfnPipe.EcsContainerOverrideProperty

Implements

CfnPipe.IEcsContainerOverrideProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Pipes

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPipe.EcsContainerOverrideProperty : CfnPipe.IEcsContainerOverrideProperty

Syntax (vb)

Public Class CfnPipe.EcsContainerOverrideProperty Implements CfnPipe.IEcsContainerOverrideProperty

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pipes;

             var ecsContainerOverrideProperty = new EcsContainerOverrideProperty {
                 Command = new [] { "command" },
                 Cpu = 123,
                 Environment = new [] { new EcsEnvironmentVariableProperty {
                     Name = "name",
                     Value = "value"
                 } },
                 EnvironmentFiles = new [] { new EcsEnvironmentFileProperty {
                     Type = "type",
                     Value = "value"
                 } },
                 Memory = 123,
                 MemoryReservation = 123,
                 Name = "name",
                 ResourceRequirements = new [] { new EcsResourceRequirementProperty {
                     Type = "type",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

EcsContainerOverrideProperty()

The overrides that are sent to a container.

Properties

Command	The command to send to the container that overrides the default command from the Docker image or the task definition.
Cpu	The number of cpu units reserved for the container, instead of the default value from the task definition.
Environment	The environment variables to send to the container.
EnvironmentFiles	A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
Memory	The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
MemoryReservation	The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
Name	The name of the container that receives the override.
ResourceRequirements	The type and amount of a resource to assign to a container, instead of the default value from the task definition.

Constructors

EcsContainerOverrideProperty()

The overrides that are sent to a container.

public EcsContainerOverrideProperty()

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pipes;

             var ecsContainerOverrideProperty = new EcsContainerOverrideProperty {
                 Command = new [] { "command" },
                 Cpu = 123,
                 Environment = new [] { new EcsEnvironmentVariableProperty {
                     Name = "name",
                     Value = "value"
                 } },
                 EnvironmentFiles = new [] { new EcsEnvironmentFileProperty {
                     Type = "type",
                     Value = "value"
                 } },
                 Memory = 123,
                 MemoryReservation = 123,
                 Name = "name",
                 ResourceRequirements = new [] { new EcsResourceRequirementProperty {
                     Type = "type",
                     Value = "value"
                 } }
             };

Properties

Command

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

public string[]? Command { get; set; }

Property Value

string[]

Remarks

You must also specify a container name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-command

Cpu

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

public double? Cpu { get; set; }

Property Value

double?

Remarks

You must also specify a container name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-cpu

Environment

The environment variables to send to the container.

public object? Environment { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-environment

EnvironmentFiles

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

public object? EnvironmentFiles { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-environmentfiles

Memory

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

public double? Memory { get; set; }

Property Value

double?

Remarks

If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-memory

MemoryReservation

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

public double? MemoryReservation { get; set; }

Property Value

double?

Remarks

You must also specify a container name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-memoryreservation

Name

The name of the container that receives the override.

public string? Name { get; set; }

Property Value

string

Remarks

This parameter is required if any override is specified.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-name

ResourceRequirements

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

public object? ResourceRequirements { get; set; }

Property Value

object

Remarks

The only supported resource is a GPU.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html#cfn-pipes-pipe-ecscontaineroverride-resourcerequirements

Implements

CfnPipe.IEcsContainerOverrideProperty