EcsFargateContainerDefinition
A container orchestrated by ECS that uses Fargate resources.
Example
const jobDefn = new batch.EcsJobDefinition(this, 'JobDefn', {
container: new batch.EcsFargateContainerDefinition(this, 'myFargateContainer', {
image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
memory: cdk.Size.mebibytes(2048),
cpu: 256,
ephemeralStorageSize: cdk.Size.gibibytes(100),
fargateCpuArchitecture: ecs.CpuArchitecture.ARM64,
fargateOperatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
}),
});
job_defn = batch.EcsJobDefinition(self, "JobDefn",
container=batch.EcsFargateContainerDefinition(self, "myFargateContainer",
image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
memory=cdk.Size.mebibytes(2048),
cpu=256,
ephemeral_storage_size=cdk.Size.gibibytes(100),
fargate_cpu_architecture=ecs.CpuArchitecture.ARM64,
fargate_operating_system_family=ecs.OperatingSystemFamily.LINUX
)
)
EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
.container(EcsFargateContainerDefinition.Builder.create(this, "myFargateContainer")
.image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
.memory(Size.mebibytes(2048))
.cpu(256)
.ephemeralStorageSize(Size.gibibytes(100))
.fargateCpuArchitecture(CpuArchitecture.ARM64)
.fargateOperatingSystemFamily(OperatingSystemFamily.LINUX)
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
var jobDefn = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
Container = new EcsFargateContainerDefinition(this, "myFargateContainer", new EcsFargateContainerDefinitionProps {
Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
Memory = Size.Mebibytes(2048),
Cpu = 256,
EphemeralStorageSize = Size.Gibibytes(100),
FargateCpuArchitecture = CpuArchitecture.ARM64,
FargateOperatingSystemFamily = OperatingSystemFamily.LINUX
})
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
jobDefn := batch.NewEcsJobDefinition(this, jsii.String("JobDefn"), &EcsJobDefinitionProps{
Container: batch.NewEcsFargateContainerDefinition(this, jsii.String("myFargateContainer"), &EcsFargateContainerDefinitionProps{
Image: ecs.ContainerImage_FromRegistry(jsii.String("public.ecr.aws/amazonlinux/amazonlinux:latest")),
Memory: cdk.Size_Mebibytes(jsii.Number(2048)),
Cpu: jsii.Number(256),
EphemeralStorageSize: cdk.Size_Gibibytes(jsii.Number(100)),
FargateCpuArchitecture: ecs.CpuArchitecture_ARM64(),
FargateOperatingSystemFamily: ecs.OperatingSystemFamily_LINUX(),
}),
})
Initializer
new EcsFargateContainerDefinition(scope: Construct, id: string, props: EcsFargateContainerDefinitionProps)
EcsFargateContainerDefinition(scope: Construct, id: str, props: EcsFargateContainerDefinitionProps)
new EcsFargateContainerDefinition(Construct scope, String id, EcsFargateContainerDefinitionProps props)
new EcsFargateContainerDefinition(Construct scope, string id, EcsFargateContainerDefinitionProps props)
NewEcsFargateContainerDefinition(Scope Construct, Id *string, Props EcsFargateContainerDefinitionProps)
Construct Props
assignPublicIpbooleanassign_public_ipboolassignPublicIpBooleanAssignPublicIpboolAssignPublicIp*bool= false#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.
commandstring[]commandtyping.List[str]commandList<String>Commandstring[]Command*[]*string= no command#Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.
enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool= undefined - AWS Batch default is…#notes · default
If true, execute command functionality is turned on all the containers in the task.
This allows you to use ECS Exec to access containers interactively. When enabled, a job role with required SSM permissions will be created automatically if no job role is provided. If a job role is alreadyprovided, the required permissions will be added to it.
Default: undefined - AWS Batch default is false
environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string= no environment variables#Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.
ephemeralStorageSizeSizeephemeral_storage_sizeSizeephemeralStorageSizeSizeEphemeralStorageSizeSizeEphemeralStorageSizeSize= 20 GiB#executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRole= a Role will be created#fargateCpuArchitectureCpuArchitecturefargate_cpu_architectureCpuArchitecturefargateCpuArchitectureCpuArchitectureFargateCpuArchitectureCpuArchitectureFargateCpuArchitectureCpuArchitecture= X86_64#fargateOperatingSystemFamilyOperatingSystemFamilyfargate_operating_system_familyOperatingSystemFamilyfargateOperatingSystemFamilyOperatingSystemFamilyFargateOperatingSystemFamilyOperatingSystemFamilyFargateOperatingSystemFamilyOperatingSystemFamily= LINUX#fargatePlatformVersionFargatePlatformVersionfargate_platform_versionFargatePlatformVersionfargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersion= LATEST#imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#linuxParametersLinuxParameterslinux_parametersLinuxParameterslinuxParametersLinuxParametersLinuxParametersLinuxParametersLinuxParametersLinuxParameters= none#loggingLogDriverloggingLogDriverloggingLogDriverLoggingLogDriverLoggingLogDriver= the log configuration of the Doc…#default
Default: the log configuration of the Docker daemon
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.
readonlyRootFilesystembooleanreadonly_root_filesystemboolreadonlyRootFilesystemBooleanReadonlyRootFilesystemboolReadonlyRootFilesystem*bool= false#secrets{ [key: string]: Secret }secretstyping.Mapping[str, Secret]secretsMap<String, Secret>SecretsIDictionary<string, Secret>Secrets*map[string]Secret= no secrets#Allows your job definitions to reference the secret by the environment variable name defined in this property.
Properties
assignPublicIpbooleanassign_public_ipboolassignPublicIpBooleanAssignPublicIpboolAssignPublicIp*bool#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.
Each vCPU is equivalent to 1,024 CPU shares. For containers running on EC2 resources, you must specify at least one vCPU.
enableExecuteCommandbooleanenable_execute_commandboolenableExecuteCommandBooleanEnableExecuteCommandboolEnableExecuteCommand*bool#environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string#Cannot start with AWS_BATCH. We don't recommend using plaintext environment variables for sensitive information, such as credential data.
ephemeralStorageSizeSizeephemeral_storage_sizeSizeephemeralStorageSizeSizeEphemeralStorageSizeSizeEphemeralStorageSizeSize#executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRolerequired#fargateCpuArchitectureCpuArchitecturefargate_cpu_architectureCpuArchitecturefargateCpuArchitectureCpuArchitectureFargateCpuArchitectureCpuArchitectureFargateCpuArchitectureCpuArchitecture#fargateOperatingSystemFamilyOperatingSystemFamilyfargate_operating_system_familyOperatingSystemFamilyfargateOperatingSystemFamilyOperatingSystemFamilyFargateOperatingSystemFamilyOperatingSystemFamilyFargateOperatingSystemFamilyOperatingSystemFamily#fargatePlatformVersionFargatePlatformVersionfargate_platform_versionFargatePlatformVersionfargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersionFargatePlatformVersion#imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImagerequired#linuxParametersLinuxParameterslinux_parametersLinuxParameterslinuxParametersLinuxParametersLinuxParametersLinuxParametersLinuxParametersLinuxParameters#logDriverConfigLogDriverConfiglog_driver_configLogDriverConfiglogDriverConfigLogDriverConfigLogDriverConfigLogDriverConfigLogDriverConfigLogDriverConfig#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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#readonlyRootFilesystembooleanreadonly_root_filesystemboolreadonlyRootFilesystemBooleanReadonlyRootFilesystemboolReadonlyRootFilesystem*bool#secrets{ [key: string]: Secret }secretstyping.Mapping[str, Secret]secretsMap<String, Secret>SecretsIDictionary<string, Secret>Secrets*map[string]Secret#Allows your job definitions to reference the secret by the environment variable name defined in this property.
Methods
addVolume(volume: EcsVolume): voiddef add_volume(self, volume: EcsVolume) -> Nonepublic void addVolume(EcsVolume volume)public void AddVolume(EcsVolume volume)func AddVolume(Volume EcsVolume)#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining