aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedTaskImageOptions

ApplicationLoadBalancedTaskImageOptions Struct

Source

aws-ecs-patterns/lib/base/application-load-balanced-service-base.ts

Type last changed

v2.50.0 · 1 Nov 2022

Example

declare const cluster: ecs.Cluster;
const loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {
  cluster,
  memoryLimitMiB: 1024,
  desiredCount: 1,
  cpu: 512,
  taskImageOptions: {
    image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  },
  minHealthyPercent: 100,
  taskSubnets: {
    subnets: [ec2.Subnet.fromSubnetId(this, 'subnet', 'VpcISOLATEDSubnet1Subnet80F07FA0')],
  },
  loadBalancerName: 'application-lb-name',
});

Properties

commandstring[]commandtyping.List[str]commandList<String>Commandstring[]Command*[]*string= none#

The command that's passed to the container.

notes

If there are multiple arguments, make sure that each argument is a separated string in the array.

This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run.

For more information about the Docker CMD parameter, see https://docs.docker.com/engine/reference/builder/#cmd.

containerNamestringcontainer_namestrcontainerNameStringContainerNamestringContainerName*string= none#

The container name value to be specified in the task definition.

containerPortnumbercontainer_portint | floatcontainerPortNumberContainerPortdoubleContainerPort*float64= 80#

The port number on the container that is bound to the user-specified or automatically assigned host port.

notes

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range.

Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

For more information, see hostPort.

dockerLabels{ [key: string]: string }docker_labelstyping.Mapping[str, str]dockerLabelsMap<String, String>DockerLabelsIDictionary<string, string>DockerLabels*map[string]*string#

A key/value map of labels to add to the container.

Default: No labels.

enableLoggingbooleanenable_loggingboolenableLoggingBooleanEnableLoggingboolEnableLogging*bool= true#

Flag to indicate whether to enable logging.

entryPointstring[]entry_pointtyping.List[str]entryPointList<String>EntryPointstring[]EntryPoint*[]*string= none#

The entry point that's passed to the container.

notes

This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run.

For more information about the Docker ENTRYPOINT parameter, see https://docs.docker.com/engine/reference/builder/#entrypoint.

environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string#

The environment variables to pass to the container.

Default: No environment variables.

executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRole#

The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf.

Default: No value

familystringfamilystrfamilyStringFamilystringFamily*string#

The name of a family that this task definition is registered to.

Default: Automatically generated name.

A family groups multiple versions of a task definition.

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImage= nonerequired#

The image used to start a container.

Image or taskDefinition must be specified, not both.

logDriverLogDriverlog_driverLogDriverlogDriverLogDriverLogDriverLogDriverLogDriverLogDriver#

The log driver to use.

Default: AwsLogDriver if enableLogging is true

secrets{ [key: string]: Secret }secretstyping.Mapping[str, Secret]secretsMap<String, Secret>SecretsIDictionary<string, Secret>Secrets*map[string]Secret#

The secret to expose to the container as an environment variable.

Default: No secret environment variables.

taskRoleIRoletask_roleIRoletaskRoleIRoleTaskRoleIRoleTaskRoleIRole#

The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf.

Default: A task role is automatically created for you.