Package software.amazon.awscdk.services.batch

Interface IEcsFargateContainerDefinition.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEcsContainerDefinition, IEcsContainerDefinition.Jsii$Default, IEcsFargateContainerDefinition, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IEcsFargateContainerDefinition.Jsii$Proxy

Enclosing interface:

IEcsFargateContainerDefinition

@Internal
public static interface IEcsFargateContainerDefinition.Jsii$Default
extends IEcsFargateContainerDefinition, IEcsContainerDefinition.Jsii$Default

Internal default implementation for IEcsFargateContainerDefinition.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEcsContainerDefinition

IEcsContainerDefinition.Jsii$Default, IEcsContainerDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.IEcsFargateContainerDefinition

IEcsFargateContainerDefinition.Jsii$Default, IEcsFargateContainerDefinition.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addVolume(EcsVolume volume)	Add a Volume to this container.
default Boolean	getAssignPublicIp()	Indicates whether the job has a public IP address.
default List<String>	getCommand()	The command that's passed to the container.
default Number	getCpu()	The number of vCPUs reserved for the container.
default Map<String,String>	getEnvironment()	The environment variables to pass to a container.
default Size	getEphemeralStorageSize()	The size for ephemeral storage.
default IRole	getExecutionRole()	The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.
default CpuArchitecture	getFargateCpuArchitecture()	The vCPU architecture of Fargate Runtime.
default OperatingSystemFamily	getFargateOperatingSystemFamily()	The operating system for the compute environment.
default FargatePlatformVersion	getFargatePlatformVersion()	Which version of Fargate to use when running this container.
default ContainerImage	getImage()	The image that this container will run.
default IRole	getJobRole()	The role that the container can assume.
default LinuxParameters	getLinuxParameters()	Linux-specific modifications that are applied to the container, such as details for device mappings.
default LogDriverConfig	getLogDriverConfig()	The configuration of the log driver.
default Size	getMemory()	The memory hard limit present to the container.
default software.constructs.Node	getNode()	The tree node.
default Boolean	getReadonlyRootFilesystem()	Gives the container readonly access to its root filesystem.
default Map<String,Secret>	getSecrets()	A map from environment variable names to the secrets for the container.
default String	getUser()	The user name to use inside the container.
default List<EcsVolume>	getVolumes()	The volumes to mount to this container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IEcsContainerDefinition.Jsii$Default

getCpu

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

The number of vCPUs reserved for the container.

Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.

Specified by:

getCpu in interface IEcsContainerDefinition

Specified by:

getCpu in interface IEcsContainerDefinition.Jsii$Default

getExecutionRole

@Stability(Stable)
@NotNull
default IRole getExecutionRole()

The role used by Amazon ECS container and AWS Fargate agents to make AWS API calls on your behalf.

Specified by:

getExecutionRole in interface IEcsContainerDefinition

Specified by:

getExecutionRole in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html

getImage

@Stability(Stable)
@NotNull
default ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

Specified by:

getImage in interface IEcsContainerDefinition.Jsii$Default

getMemory

@Stability(Stable)
@NotNull
default Size getMemory()

The memory hard limit present to the container.

If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job.

Specified by:

getMemory in interface IEcsContainerDefinition

Specified by:

getMemory in interface IEcsContainerDefinition.Jsii$Default

getVolumes

@Stability(Stable)
@NotNull
default List<EcsVolume> getVolumes()

The volumes to mount to this container.

Automatically added to the job definition.

Default: - no volumes

Specified by:

getVolumes in interface IEcsContainerDefinition

Specified by:

getVolumes in interface IEcsContainerDefinition.Jsii$Default

getCommand

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

The command that's passed to the container.

Specified by:

getCommand in interface IEcsContainerDefinition

Specified by:

getCommand in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.docker.com/engine/reference/builder/#cmd

getEnvironment

@Stability(Stable)
@Nullable
default Map<String,String> getEnvironment()

The environment variables to pass to a container.

Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Default: - no environment variables

Specified by:

getEnvironment in interface IEcsContainerDefinition

Specified by:

getEnvironment in interface IEcsContainerDefinition.Jsii$Default

getJobRole

@Stability(Stable)
@Nullable
default IRole getJobRole()

The role that the container can assume.

Default: - no jobRole

Specified by:

getJobRole in interface IEcsContainerDefinition

Specified by:

getJobRole in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html

getLinuxParameters

@Stability(Stable)
@Nullable
default LinuxParameters getLinuxParameters()

Linux-specific modifications that are applied to the container, such as details for device mappings.

Default: none

Specified by:

getLinuxParameters in interface IEcsContainerDefinition

Specified by:

getLinuxParameters in interface IEcsContainerDefinition.Jsii$Default

getLogDriverConfig

@Stability(Stable)
@Nullable
default LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition.Jsii$Default

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
default Boolean getReadonlyRootFilesystem()

Gives the container readonly access to its root filesystem.

Default: false

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition

Specified by:

getReadonlyRootFilesystem in interface IEcsContainerDefinition.Jsii$Default

getSecrets

@Stability(Stable)
@Nullable
default Map<String,Secret> getSecrets()

A map from environment variable names to the secrets for the container.

Allows your job definitions to reference the secret by the environment variable name defined in this property.

Default: - no secrets

Specified by:

getSecrets in interface IEcsContainerDefinition

Specified by:

getSecrets in interface IEcsContainerDefinition.Jsii$Default

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html

getUser

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

The user name to use inside the container.

Default: - no user

Specified by:

getUser in interface IEcsContainerDefinition

Specified by:

getUser in interface IEcsContainerDefinition.Jsii$Default

getAssignPublicIp

@Stability(Stable)
@Nullable
default Boolean getAssignPublicIp()

Indicates whether the job has a public IP address.

For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet.

Default: false

Specified by:

getAssignPublicIp in interface IEcsFargateContainerDefinition

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html

getEphemeralStorageSize

@Stability(Stable)
@Nullable
default Size getEphemeralStorageSize()

The size for ephemeral storage.

Default: - 20 GiB

Specified by:

getEphemeralStorageSize in interface IEcsFargateContainerDefinition

getFargateCpuArchitecture

@Stability(Stable)
@Nullable
default CpuArchitecture getFargateCpuArchitecture()

The vCPU architecture of Fargate Runtime.

Default: - X86_64

Specified by:

getFargateCpuArchitecture in interface IEcsFargateContainerDefinition

getFargateOperatingSystemFamily

@Stability(Stable)
@Nullable
default OperatingSystemFamily getFargateOperatingSystemFamily()

The operating system for the compute environment.

Default: - LINUX

Specified by:

getFargateOperatingSystemFamily in interface IEcsFargateContainerDefinition

getFargatePlatformVersion

@Stability(Stable)
@Nullable
default FargatePlatformVersion getFargatePlatformVersion()

Which version of Fargate to use when running this container.

Default: LATEST

Specified by:

getFargatePlatformVersion in interface IEcsFargateContainerDefinition

addVolume

@Stability(Stable)
default void addVolume(@NotNull
 EcsVolume volume)

Add a Volume to this container.

Specified by:

addVolume in interface IEcsContainerDefinition

Specified by:

addVolume in interface IEcsContainerDefinition.Jsii$Default

Parameters:

volume - This parameter is required.