interface FirelensLogRouterDefinitionOptions

Language	Type name
.NET	Amazon.CDK.AWS.ECS.FirelensLogRouterDefinitionOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#FirelensLogRouterDefinitionOptions
Java	software.amazon.awscdk.services.ecs.FirelensLogRouterDefinitionOptions
Python	aws_cdk.aws_ecs.FirelensLogRouterDefinitionOptions
TypeScript (source)	aws-cdk-lib » aws_ecs » FirelensLogRouterDefinitionOptions

The options for creating a firelens log router.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';

declare const appProtocol: ecs.AppProtocol;
declare const containerImage: ecs.ContainerImage;
declare const credentialSpec: ecs.CredentialSpec;
declare const environmentFile: ecs.EnvironmentFile;
declare const linuxParameters: ecs.LinuxParameters;
declare const logDriver: ecs.LogDriver;
declare const secret: ecs.Secret;
const firelensLogRouterDefinitionOptions: ecs.FirelensLogRouterDefinitionOptions = {
  firelensConfig: {
    type: ecs.FirelensLogRouterType.FLUENTBIT,

    // the properties below are optional
    options: {
      configFileType: ecs.FirelensConfigFileType.S3,
      configFileValue: 'configFileValue',
      enableECSLogMetadata: false,
    },
  },
  image: containerImage,

  // the properties below are optional
  command: ['command'],
  containerName: 'containerName',
  cpu: 123,
  credentialSpecs: [credentialSpec],
  disableNetworking: false,
  dnsSearchDomains: ['dnsSearchDomains'],
  dnsServers: ['dnsServers'],
  dockerLabels: {
    dockerLabelsKey: 'dockerLabels',
  },
  dockerSecurityOptions: ['dockerSecurityOptions'],
  enableRestartPolicy: false,
  entryPoint: ['entryPoint'],
  environment: {
    environmentKey: 'environment',
  },
  environmentFiles: [environmentFile],
  essential: false,
  extraHosts: {
    extraHostsKey: 'extraHosts',
  },
  gpuCount: 123,
  healthCheck: {
    command: ['command'],

    // the properties below are optional
    interval: cdk.Duration.minutes(30),
    retries: 123,
    startPeriod: cdk.Duration.minutes(30),
    timeout: cdk.Duration.minutes(30),
  },
  hostname: 'hostname',
  inferenceAcceleratorResources: ['inferenceAcceleratorResources'],
  interactive: false,
  linuxParameters: linuxParameters,
  logging: logDriver,
  memoryLimitMiB: 123,
  memoryReservationMiB: 123,
  portMappings: [{
    containerPort: 123,

    // the properties below are optional
    appProtocol: appProtocol,
    containerPortRange: 'containerPortRange',
    hostPort: 123,
    name: 'name',
    protocol: ecs.Protocol.TCP,
  }],
  privileged: false,
  pseudoTerminal: false,
  readonlyRootFilesystem: false,
  restartAttemptPeriod: cdk.Duration.minutes(30),
  restartIgnoredExitCodes: [123],
  secrets: {
    secretsKey: secret,
  },
  startTimeout: cdk.Duration.minutes(30),
  stopTimeout: cdk.Duration.minutes(30),
  systemControls: [{
    namespace: 'namespace',
    value: 'value',
  }],
  ulimits: [{
    hardLimit: 123,
    name: ecs.UlimitName.CORE,
    softLimit: 123,
  }],
  user: 'user',
  workingDirectory: 'workingDirectory',
};

Properties

Name	Type	Description
firelensConfig	FirelensConfig	Firelens configuration.
image	ContainerImage	The image used to start a container.
command?	string[]	The command that is passed to the container.
containerName?	string	The name of the container.
cpu?	number	The minimum number of CPU units to reserve for the container.
credentialSpecs?	CredentialSpec[]	A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication.
disableNetworking?	boolean	Specifies whether networking is disabled within the container.
dnsSearchDomains?	string[]	A list of DNS search domains that are presented to the container.
dnsServers?	string[]	A list of DNS servers that are presented to the container.
dockerLabels?	{ [string]: string }	A key/value map of labels to add to the container.
dockerSecurityOptions?	string[]	A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
enableRestartPolicy?	boolean	Enable a restart policy for a container.
entryPoint?	string[]	The ENTRYPOINT value to pass to the container.
environment?	{ [string]: string }	The environment variables to pass to the container.
environmentFiles?	EnvironmentFile[]	The environment files to pass to the container.
essential?	boolean	Specifies whether the container is marked essential.
extraHosts?	{ [string]: string }	A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
gpuCount?	number	The number of GPUs assigned to the container.
healthCheck?	HealthCheck	The health check command and associated configuration parameters for the container.
hostname?	string	The hostname to use for your container.
inferenceAcceleratorResources?	string[]	The inference accelerators referenced by the container.
interactive?	boolean	When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated.
linuxParameters?	LinuxParameters	Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
logging?	LogDriver	The log configuration specification for the container.
memoryLimitMiB?	number	The amount (in MiB) of memory to present to the container.
memoryReservationMiB?	number	The soft limit (in MiB) of memory to reserve for the container.
portMappings?	PortMapping[]	The port mappings to add to the container definition.
privileged?	boolean	Specifies whether the container is marked as privileged.
pseudoTerminal?	boolean	When this parameter is true, a TTY is allocated.
readonlyRootFilesystem?	boolean	When this parameter is true, the container is given read-only access to its root file system.
restartAttemptPeriod?	Duration	A period of time that the container must run for before a restart can be attempted.
restartIgnoredExitCodes?	number[]	A list of exit codes that Amazon ECS will ignore and not attempt a restart on.
secrets?	{ [string]: Secret }	The secret environment variables to pass to the container.
startTimeout?	Duration	Time duration (in seconds) to wait before giving up on resolving dependencies for a container.
stopTimeout?	Duration	Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
systemControls?	SystemControl[]	A list of namespaced kernel parameters to set in the container.
ulimits?	Ulimit[]	An array of ulimits to set in the container.
user?	string	The user to use inside the container.
workingDirectory?	string	The working directory in which to run commands inside the container.

---

firelensConfig

Type: FirelensConfig

Firelens configuration.

---

image

Type: ContainerImage

The image used to start a container.

This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. TODO: Update these to specify using classes of IContainerImage

---

command?

Type: string[] (optional, default: CMD value built into container image.)

The command that is passed to the container.

If you provide a shell command as a single string, you have to quote command-line arguments.

---

containerName?

Type: string (optional, default: id of node associated with ContainerDefinition.)

The name of the container.

---

cpu?

Type: number (optional, default: No minimum CPU units reserved.)

The minimum number of CPU units to reserve for the container.

---

credentialSpecs?

Type: CredentialSpec[] (optional, default: No credential specs.)

A list of ARNs in SSM or Amazon S3 to a credential spec (CredSpec) file that configures the container for Active Directory authentication.

We recommend that you use this parameter instead of the dockerSecurityOptions.

Currently, only one credential spec is allowed per container definition.

---

disableNetworking?

Type: boolean (optional, default: false)

Specifies whether networking is disabled within the container.

When this parameter is true, networking is disabled within the container.

---

dnsSearchDomains?

Type: string[] (optional, default: No search domains.)

A list of DNS search domains that are presented to the container.

---

dnsServers?

Type: string[] (optional, default: Default DNS servers.)

A list of DNS servers that are presented to the container.

---

dockerLabels?

Type: { [string]: string } (optional, default: No labels.)

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

---

dockerSecurityOptions?

Type: string[] (optional, default: No security labels.)

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

---

enableRestartPolicy?

Type: boolean (optional, default: false unless restartIgnoredExitCodes or restartAttemptPeriod is set.)

Enable a restart policy for a container.

When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-restart-policy.html

---

entryPoint?

Type: string[] (optional, default: Entry point configured in container.)

The ENTRYPOINT value to pass to the container.

See also: https://docs.docker.com/engine/reference/builder/#entrypoint

---

environment?

Type: { [string]: string } (optional, default: No environment variables.)

The environment variables to pass to the container.

---

environmentFiles?

Type: EnvironmentFile[] (optional, default: No environment files.)

The environment files to pass to the container.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html

---

essential?

Type: boolean (optional, default: true)

Specifies whether the container is marked essential.

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. All tasks must have at least one essential container.

If this parameter is omitted, a container is assumed to be essential.

---

extraHosts?

Type: { [string]: string } (optional, default: No extra hosts.)

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

---

gpuCount?

Type: number (optional, default: No GPUs assigned.)

The number of GPUs assigned to the container.

---

healthCheck?

Type: HealthCheck (optional, default: Health check configuration from container.)

The health check command and associated configuration parameters for the container.

---

hostname?

Type: string (optional, default: Automatic hostname.)

The hostname to use for your container.

---

inferenceAcceleratorResources?

Type: string[] (optional, default: No inference accelerators assigned.)

The inference accelerators referenced by the container.

---

interactive?

Type: boolean (optional, default: false)

When this parameter is true, you can deploy containerized applications that require stdin or a tty to be allocated.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-interactive

---

linuxParameters?

Type: LinuxParameters (optional, default: No Linux parameters.)

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

For more information see KernelCapabilities.

---

logging?

Type: LogDriver (optional, default: Containers use the same logging driver that the Docker daemon uses.)

The log configuration specification for the container.

---

memoryLimitMiB?

Type: number (optional, default: No memory limit.)

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

---

memoryReservationMiB?

Type: number (optional, default: No memory reserved.)

The soft limit (in MiB) of memory to reserve for the container.

When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services.

---

portMappings?

Type: PortMapping[] (optional, default: No ports are mapped.)

The port mappings to add to the container definition.

---

privileged?

Type: boolean (optional, default: false)

Specifies whether the container is marked as privileged.

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

---

pseudoTerminal?

Type: boolean (optional, default: false)

When this parameter is true, a TTY is allocated.

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

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_pseudoterminal

---

readonlyRootFilesystem?

Type: boolean (optional, default: false)

When this parameter is true, the container is given read-only access to its root file system.

---

restartAttemptPeriod?

Type: Duration (optional, default: Duration.seconds(300) if enableRestartPolicy is true, otherwise no period.)

A period of time that the container must run for before a restart can be attempted.

A container can be restarted only once every restartAttemptPeriod seconds. If a container isn't able to run for this time period and exits early, it will not be restarted.

This property can't be used if enableRestartPolicy is set to false.

You can set a minimum restartAttemptPeriod of 60 seconds and a maximum restartAttemptPeriod of 1800 seconds.

---

restartIgnoredExitCodes?

Type: number[] (optional, default: No exit codes are ignored.)

A list of exit codes that Amazon ECS will ignore and not attempt a restart on.

This property can't be used if enableRestartPolicy is set to false.

You can specify a maximum of 50 container exit codes.

---

secrets?

Type: { [string]: Secret } (optional, default: No secret environment variables.)

The secret environment variables to pass to the container.

---

startTimeout?

Type: Duration (optional, default: none)

Time duration (in seconds) to wait before giving up on resolving dependencies for a container.

---

stopTimeout?

Type: Duration (optional, default: none)

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.

---

systemControls?

Type: SystemControl[] (optional, default: No system controls are set.)

A list of namespaced kernel parameters to set in the container.

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols

---

ulimits?

Type: Ulimit[] (optional)

An array of ulimits to set in the container.

---

user?

Type: string (optional, default: root)

The user to use inside the container.

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

See also: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#ContainerDefinition-user

---

workingDirectory?

Type: string (optional, default: /)

The working directory in which to run commands inside the container.