software.amazon.awscdk.services.ecs

Class FirelensLogRouter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.ecs.ContainerDefinition

software.amazon.awscdk.services.ecs.FirelensLogRouter

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.708Z")
 @Stability(value=Stable)
public class FirelensLogRouter
extends ContainerDefinition

Firelens log router.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecs.*;
 ContainerImage containerImage;
 EnvironmentFile environmentFile;
 LinuxParameters linuxParameters;
 LogDriver logDriver;
 Secret secret;
 TaskDefinition taskDefinition;
 FirelensLogRouter firelensLogRouter = FirelensLogRouter.Builder.create(this, "MyFirelensLogRouter")
         .firelensConfig(FirelensConfig.builder()
                 .type(FirelensLogRouterType.FLUENTBIT)
                 // the properties below are optional
                 .options(FirelensOptions.builder()
                         .configFileType(FirelensConfigFileType.S3)
                         .configFileValue("configFileValue")
                         .enableECSLogMetadata(false)
                         .build())
                 .build())
         .image(containerImage)
         .taskDefinition(taskDefinition)
         // the properties below are optional
         .command(List.of("command"))
         .containerName("containerName")
         .cpu(123)
         .disableNetworking(false)
         .dnsSearchDomains(List.of("dnsSearchDomains"))
         .dnsServers(List.of("dnsServers"))
         .dockerLabels(Map.of(
                 "dockerLabelsKey", "dockerLabels"))
         .dockerSecurityOptions(List.of("dockerSecurityOptions"))
         .entryPoint(List.of("entryPoint"))
         .environment(Map.of(
                 "environmentKey", "environment"))
         .environmentFiles(List.of(environmentFile))
         .essential(false)
         .extraHosts(Map.of(
                 "extraHostsKey", "extraHosts"))
         .gpuCount(123)
         .healthCheck(HealthCheck.builder()
                 .command(List.of("command"))
                 // the properties below are optional
                 .interval(Duration.minutes(30))
                 .retries(123)
                 .startPeriod(Duration.minutes(30))
                 .timeout(Duration.minutes(30))
                 .build())
         .hostname("hostname")
         .inferenceAcceleratorResources(List.of("inferenceAcceleratorResources"))
         .linuxParameters(linuxParameters)
         .logging(logDriver)
         .memoryLimitMiB(123)
         .memoryReservationMiB(123)
         .portMappings(List.of(PortMapping.builder()
                 .containerPort(123)
                 // the properties below are optional
                 .hostPort(123)
                 .protocol(Protocol.TCP)
                 .build()))
         .privileged(false)
         .readonlyRootFilesystem(false)
         .secrets(Map.of(
                 "secretsKey", secret))
         .startTimeout(Duration.minutes(30))
         .stopTimeout(Duration.minutes(30))
         .systemControls(List.of(SystemControl.builder()
                 .namespace("namespace")
                 .value("value")
                 .build()))
         .user("user")
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirelensLogRouter.Builder A fluent builder for FirelensLogRouter.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	FirelensLogRouter(software.constructs.Construct scope, String id, FirelensLogRouterProps props) Constructs a new instance of the FirelensLogRouter class.
protected	FirelensLogRouter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FirelensLogRouter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
FirelensConfig	getFirelensConfig() Firelens configuration.
CfnTaskDefinition.ContainerDefinitionProperty	renderContainerDefinition() Render this container definition to a CloudFormation object.
CfnTaskDefinition.ContainerDefinitionProperty	renderContainerDefinition(TaskDefinition _taskDefinition) Render this container definition to a CloudFormation object.

Methods inherited from class software.amazon.awscdk.services.ecs.ContainerDefinition

addContainerDependencies, addEnvironment, addInferenceAcceleratorResource, addLink, addLink, addMountPoints, addPortMappings, addScratch, addSecret, addToExecutionPolicy, addUlimits, addVolumesFrom, findPortMapping, getContainerDependencies, getContainerName, getContainerPort, getEnvironmentFiles, getEssential, getImageName, getIngressPort, getLinuxParameters, getLogDriverConfig, getMemoryLimitSpecified, getMountPoints, getPortMappings, getReferencesSecretJsonField, getTaskDefinition, getUlimits, getVolumesFrom

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

FirelensLogRouter

protected FirelensLogRouter(software.amazon.jsii.JsiiObjectRef objRef)

FirelensLogRouter

protected FirelensLogRouter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

FirelensLogRouter

@Stability(value=Stable)
public FirelensLogRouter(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  FirelensLogRouterProps props)

Constructs a new instance of the FirelensLogRouter class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

renderContainerDefinition

@Stability(value=Stable)
 @NotNull
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition(@Nullable
                                                                                                                  TaskDefinition _taskDefinition)

Render this container definition to a CloudFormation object.

Overrides:

renderContainerDefinition in class ContainerDefinition

Parameters:

_taskDefinition -

renderContainerDefinition

@Stability(value=Stable)
 @NotNull
public CfnTaskDefinition.ContainerDefinitionProperty renderContainerDefinition()

Render this container definition to a CloudFormation object.

Overrides:

renderContainerDefinition in class ContainerDefinition

getFirelensConfig

@Stability(value=Stable)
 @NotNull
public FirelensConfig getFirelensConfig()

Firelens configuration.