MDAA TS Docs
    Preparing search index...

    Interface MdaaECSContainerDefinitionProps

    Properties for creating a Compliance ECS containerdefinition

    interface MdaaECSContainerDefinitionProps {
        command?: string[];
        containerName?: string;
        cpu?: number;
        createOutputs?: boolean;
        createParams?: boolean;
        datetimeFormat?: string;
        disableNetworking?: boolean;
        dnsSearchDomains?: string[];
        dnsServers?: string[];
        dockerLabels?: { [key: string]: string };
        dockerSecurityOptions?: string[];
        entryPoint?: string[];
        environment?: { [key: string]: string };
        environmentFiles?: EnvironmentFile[];
        essential?: boolean;
        extraHosts?: { [name: string]: string };
        gpuCount?: number;
        healthCheck?: HealthCheck;
        hostname?: string;
        image: ContainerImage;
        inferenceAcceleratorResources?: string[];
        linuxParameters?: LinuxParameters;
        logGroup: ILogGroup;
        memoryLimitMiB?: number;
        memoryReservationMiB?: number;
        multilinePattern?: string;
        naming: IMdaaResourceNaming;
        portMappings?: PortMapping[];
        privileged?: boolean;
        pseudoTerminal?: boolean;
        readonlyRootFilesystem?: boolean;
        secrets?: { [key: string]: Secret };
        startTimeout?: Duration;
        stopTimeout?: Duration;
        streamPrefix: string;
        systemControls?: SystemControl[];
        taskDefinition: TaskDefinition;
        ulimits?: Ulimit[];
        user?: string;
        workingDirectory?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    command? containerName? cpu? createOutputs? createParams? datetimeFormat? disableNetworking? dnsSearchDomains? dnsServers? dockerLabels? dockerSecurityOptions? entryPoint? environment? environmentFiles? essential? extraHosts? gpuCount? healthCheck? hostname? image inferenceAcceleratorResources? linuxParameters? logGroup memoryLimitMiB? memoryReservationMiB? multilinePattern? naming portMappings? privileged? pseudoTerminal? readonlyRootFilesystem? secrets? startTimeout? stopTimeout? streamPrefix systemControls? taskDefinition ulimits? user? workingDirectory?

    Properties

    command?: string[]

    Command array for container execution overriding the default CMD built into the container image

    containerName?: string
    cpu?: number
    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    datetimeFormat?: string

    This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages.

    - No multiline matching.
    disableNetworking?: boolean
    dnsSearchDomains?: string[]
    dnsServers?: string[]
    dockerLabels?: { [key: string]: string }
    dockerSecurityOptions?: string[]
    entryPoint?: string[]
    environment?: { [key: string]: string }

    Environment variables map for container configuration enabling application configuration

    environmentFiles?: EnvironmentFile[]
    essential?: boolean

    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.

    true
    extraHosts?: { [name: string]: string }

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

    - No extra hosts.
    gpuCount?: number

    The number of GPUs assigned to the container.

    - No GPUs assigned.
    healthCheck?: HealthCheck

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

    - Health check configuration from container.
    hostname?: string

    The hostname to use for your container.

    - Automatic hostname.
    image: ContainerImage
    inferenceAcceleratorResources?: string[]

    The inference accelerators referenced by the container.

    - No inference accelerators assigned.
    linuxParameters?: LinuxParameters

    Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

    - No Linux parameters.
    logGroup: ILogGroup

    The log group to log to

    - A log group is automatically created.
    memoryLimitMiB?: number

    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.

    - No memory limit.
    memoryReservationMiB?: number

    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.

    - No memory reserved.
    multilinePattern?: string

    This option defines a multiline start pattern using a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages. This option is ignored if datetimeFormat is also configured.

    - No multiline matching.
    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    portMappings?: PortMapping[]

    The port mappings to add to the container definition.

    - No ports are mapped.
    privileged?: boolean

    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).

    false
    pseudoTerminal?: boolean

    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.

    - false
    See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_pseudoterminal
    readonlyRootFilesystem?: boolean

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

    false
    secrets?: { [key: string]: Secret }
    startTimeout?: Duration

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

    - none
    stopTimeout?: Duration

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

    - none
    streamPrefix: string

    Prefix for the log streams The awslogs-stream-prefix option allows you to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task to which the container belongs. If you specify a prefix with this option, then the log stream takes the following format: prefix-name/container-name/ecs-task-id

    systemControls?: SystemControl[]

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

    - No system controls are set.
    See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html
    See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols
    taskDefinition: TaskDefinition
    ulimits?: Ulimit[]

    An array of ulimits to set in the container.

    user?: string

    The user name to use inside the container.

    root
    workingDirectory?: string

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

    /

    Settings

    Member Visibility

    On This Page

    Properties