Package software.amazon.awscdk.services.batch

Class IEcsFargateContainerDefinition.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.IEcsFargateContainerDefinition.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IEcsFargateContainerDefinition

@Internal
public static final class IEcsFargateContainerDefinition.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IEcsFargateContainerDefinition.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final 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

Specified by:

getNode in interface IEcsFargateContainerDefinition.Jsii$Default

getCpu

@Stability(Stable)
@NotNull
public final 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

Specified by:

getCpu in interface IEcsFargateContainerDefinition.Jsii$Default

getExecutionRole

@Stability(Stable)
@NotNull
public final 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

Specified by:

getExecutionRole in interface IEcsFargateContainerDefinition.Jsii$Default

See Also:

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

getImage

@Stability(Stable)
@NotNull
public final ContainerImage getImage()

The image that this container will run.

Specified by:

getImage in interface IEcsContainerDefinition

Specified by:

getImage in interface IEcsContainerDefinition.Jsii$Default

Specified by:

getImage in interface IEcsFargateContainerDefinition.Jsii$Default

getMemory

@Stability(Stable)
@NotNull
public final 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

Specified by:

getMemory in interface IEcsFargateContainerDefinition.Jsii$Default

getVolumes

@Stability(Stable)
@NotNull
public final 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

Specified by:

getVolumes in interface IEcsFargateContainerDefinition.Jsii$Default

getCommand

@Stability(Stable)
@Nullable
public final 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

Specified by:

getCommand in interface IEcsFargateContainerDefinition.Jsii$Default

See Also:

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

getEnableExecuteCommand

@Stability(Stable)
@Nullable
public final Boolean getEnableExecuteCommand()

Whether to enable ecs exec for this container.

Default: undefined - AWS Batch default is false

Specified by:

getEnableExecuteCommand in interface IEcsContainerDefinition

Specified by:

getEnableExecuteCommand in interface IEcsContainerDefinition.Jsii$Default

Specified by:

getEnableExecuteCommand in interface IEcsFargateContainerDefinition.Jsii$Default

getEnvironment

@Stability(Stable)
@Nullable
public final 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

Specified by:

getEnvironment in interface IEcsFargateContainerDefinition.Jsii$Default

getJobRole

@Stability(Stable)
@Nullable
public final 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

Specified by:

getJobRole in interface IEcsFargateContainerDefinition.Jsii$Default

See Also:

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

getLinuxParameters

@Stability(Stable)
@Nullable
public final 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

Specified by:

getLinuxParameters in interface IEcsFargateContainerDefinition.Jsii$Default

getLogDriverConfig

@Stability(Stable)
@Nullable
public final LogDriverConfig getLogDriverConfig()

The configuration of the log driver.

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition

Specified by:

getLogDriverConfig in interface IEcsContainerDefinition.Jsii$Default

Specified by:

getLogDriverConfig in interface IEcsFargateContainerDefinition.Jsii$Default

getReadonlyRootFilesystem

@Stability(Stable)
@Nullable
public final 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

Specified by:

getReadonlyRootFilesystem in interface IEcsFargateContainerDefinition.Jsii$Default

getSecrets

@Stability(Stable)
@Nullable
public final 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

Specified by:

getSecrets in interface IEcsFargateContainerDefinition.Jsii$Default

See Also:

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

getUser

@Stability(Stable)
@Nullable
public final 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

Specified by:

getUser in interface IEcsFargateContainerDefinition.Jsii$Default

getAssignPublicIp

@Stability(Stable)
@Nullable
public final 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

Specified by:

getAssignPublicIp in interface IEcsFargateContainerDefinition.Jsii$Default

See Also:

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

getEphemeralStorageSize

@Stability(Stable)
@Nullable
public final Size getEphemeralStorageSize()

The size for ephemeral storage.

Default: - 20 GiB

Specified by:

getEphemeralStorageSize in interface IEcsFargateContainerDefinition

Specified by:

getEphemeralStorageSize in interface IEcsFargateContainerDefinition.Jsii$Default

getFargateCpuArchitecture

@Stability(Stable)
@Nullable
public final CpuArchitecture getFargateCpuArchitecture()

The vCPU architecture of Fargate Runtime.

Default: - X86_64

Specified by:

getFargateCpuArchitecture in interface IEcsFargateContainerDefinition

Specified by:

getFargateCpuArchitecture in interface IEcsFargateContainerDefinition.Jsii$Default

getFargateOperatingSystemFamily

@Stability(Stable)
@Nullable
public final OperatingSystemFamily getFargateOperatingSystemFamily()

The operating system for the compute environment.

Default: - LINUX

Specified by:

getFargateOperatingSystemFamily in interface IEcsFargateContainerDefinition

Specified by:

getFargateOperatingSystemFamily in interface IEcsFargateContainerDefinition.Jsii$Default

getFargatePlatformVersion

@Stability(Stable)
@Nullable
public final FargatePlatformVersion getFargatePlatformVersion()

Which version of Fargate to use when running this container.

Default: LATEST

Specified by:

getFargatePlatformVersion in interface IEcsFargateContainerDefinition

Specified by:

getFargatePlatformVersion in interface IEcsFargateContainerDefinition.Jsii$Default

addVolume

@Stability(Stable)
public final 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

Specified by:

addVolume in interface IEcsFargateContainerDefinition.Jsii$Default

Parameters:

volume - This parameter is required.