Package software.amazon.awscdk.services.pipes

Interface CfnPipe.EcsContainerOverrideProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.EcsContainerOverrideProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.EcsContainerOverrideProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 EcsContainerOverrideProperty ecsContainerOverrideProperty = EcsContainerOverrideProperty.builder()
         .command(List.of("command"))
         .cpu(123)
         .environment(List.of(EcsEnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .environmentFiles(List.of(EcsEnvironmentFileProperty.builder()
                 .type("type")
                 .value("value")
                 .build()))
         .memory(123)
         .memoryReservation(123)
         .name("name")
         .resourceRequirements(List.of(EcsResourceRequirementProperty.builder()
                 .type("type")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.EcsContainerOverrideProperty.Builder	A builder for CfnPipe.EcsContainerOverrideProperty
static final class	CfnPipe.EcsContainerOverrideProperty.Jsii$Proxy	An implementation for CfnPipe.EcsContainerOverrideProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.EcsContainerOverrideProperty.Builder	builder()
default List<String>	getCommand()	The command to send to the container that overrides the default command from the Docker image or the task definition.
default Number	getCpu()	The number of cpu units reserved for the container, instead of the default value from the task definition.
default Object	getEnvironment()	The environment variables to send to the container.
default Object	getEnvironmentFiles()	A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
default Number	getMemory()	The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition.
default Number	getMemoryReservation()	The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition.
default String	getName()	The name of the container that receives the override.
default Object	getResourceRequirements()	The type and amount of a resource to assign to a container, instead of the default value from the task definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

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.

See Also:

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

getCpu

@Stability(Stable)
@Nullable
default Number getCpu()

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.

See Also:

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

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipe.EcsEnvironmentVariableProperty>

See Also:

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

getEnvironmentFiles

@Stability(Stable)
@Nullable
default Object getEnvironmentFiles()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipe.EcsEnvironmentFileProperty>

See Also:

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

getMemory

@Stability(Stable)
@Nullable
default Number getMemory()

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.

See Also:

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

getMemoryReservation

@Stability(Stable)
@Nullable
default Number getMemoryReservation()

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.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the container that receives the override.

This parameter is required if any override is specified.

See Also:

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

getResourceRequirements

@Stability(Stable)
@Nullable
default Object getResourceRequirements()

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipe.EcsResourceRequirementProperty>

See Also:

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

builder

@Stability(Stable)
static CfnPipe.EcsContainerOverrideProperty.Builder builder()

Returns:

a CfnPipe.EcsContainerOverrideProperty.Builder of CfnPipe.EcsContainerOverrideProperty