Interface IContainerDefinitionProps

The properties in a container definition.

Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IContainerDefinitionProps : IContainerDefinitionOptions
Syntax (vb)
Public Interface IContainerDefinitionProps Inherits IContainerDefinitionOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.ECS;

            AppProtocol appProtocol;
            ContainerImage containerImage;
            CredentialSpec credentialSpec;
            EnvironmentFile environmentFile;
            LinuxParameters linuxParameters;
            LogDriver logDriver;
            Secret secret;
            TaskDefinition taskDefinition;

            var containerDefinitionProps = new ContainerDefinitionProps {
                Image = containerImage,
                TaskDefinition = taskDefinition,

                // the properties below are optional
                Command = new [] { "command" },
                ContainerName = "containerName",
                Cpu = 123,
                CredentialSpecs = new [] { credentialSpec },
                DisableNetworking = false,
                DnsSearchDomains = new [] { "dnsSearchDomains" },
                DnsServers = new [] { "dnsServers" },
                DockerLabels = new Dictionary<string, string> {
                    { "dockerLabelsKey", "dockerLabels" }
                },
                DockerSecurityOptions = new [] { "dockerSecurityOptions" },
                EnableRestartPolicy = false,
                EntryPoint = new [] { "entryPoint" },
                Environment = new Dictionary<string, string> {
                    { "environmentKey", "environment" }
                },
                EnvironmentFiles = new [] { environmentFile },
                Essential = false,
                ExtraHosts = new Dictionary<string, string> {
                    { "extraHostsKey", "extraHosts" }
                },
                GpuCount = 123,
                HealthCheck = new HealthCheck {
                    Command = new [] { "command" },

                    // the properties below are optional
                    Interval = Duration.Minutes(30),
                    Retries = 123,
                    StartPeriod = Duration.Minutes(30),
                    Timeout = Duration.Minutes(30)
                },
                Hostname = "hostname",
                InferenceAcceleratorResources = new [] { "inferenceAcceleratorResources" },
                Interactive = false,
                LinuxParameters = linuxParameters,
                Logging = logDriver,
                MemoryLimitMiB = 123,
                MemoryReservationMiB = 123,
                PortMappings = new [] { new PortMapping {
                    ContainerPort = 123,

                    // the properties below are optional
                    AppProtocol = appProtocol,
                    ContainerPortRange = "containerPortRange",
                    HostPort = 123,
                    Name = "name",
                    Protocol = Protocol.TCP
                } },
                Privileged = false,
                PseudoTerminal = false,
                ReadonlyRootFilesystem = false,
                RestartAttemptPeriod = Duration.Minutes(30),
                RestartIgnoredExitCodes = new [] { 123 },
                Secrets = new Dictionary<string, Secret> {
                    { "secretsKey", secret }
                },
                StartTimeout = Duration.Minutes(30),
                StopTimeout = Duration.Minutes(30),
                SystemControls = new [] { new SystemControl {
                    Namespace = "namespace",
                    Value = "value"
                } },
                Ulimits = new [] { new Ulimit {
                    HardLimit = 123,
                    Name = UlimitName.CORE,
                    SoftLimit = 123
                } },
                User = "user",
                VersionConsistency = VersionConsistency.ENABLED,
                WorkingDirectory = "workingDirectory"
            };

Synopsis

Properties

TaskDefinition

The name of the task definition that includes this container definition.

Properties

TaskDefinition

The name of the task definition that includes this container definition.

TaskDefinition TaskDefinition { get; }
Property Value

TaskDefinition

Remarks

[disable-awslint:ref-via-interface]