Interface ContainerDefinitionProps
- All Superinterfaces:
ContainerDefinitionOptions
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
FirelensLogRouterProps
- All Known Implementing Classes:
ContainerDefinitionProps.Jsii$Proxy
,FirelensLogRouterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:32.793Z")
@Stability(Stable)
public interface ContainerDefinitionProps
extends software.amazon.jsii.JsiiSerializable, ContainerDefinitionOptions
The properties in a container definition.
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.*; AppProtocol appProtocol; ContainerImage containerImage; CredentialSpec credentialSpec; EnvironmentFile environmentFile; LinuxParameters linuxParameters; LogDriver logDriver; Secret secret; TaskDefinition taskDefinition; ContainerDefinitionProps containerDefinitionProps = ContainerDefinitionProps.builder() .image(containerImage) .taskDefinition(taskDefinition) // the properties below are optional .command(List.of("command")) .containerName("containerName") .cpu(123) .credentialSpecs(List.of(credentialSpec)) .disableNetworking(false) .dnsSearchDomains(List.of("dnsSearchDomains")) .dnsServers(List.of("dnsServers")) .dockerLabels(Map.of( "dockerLabelsKey", "dockerLabels")) .dockerSecurityOptions(List.of("dockerSecurityOptions")) .enableRestartPolicy(false) .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")) .interactive(false) .linuxParameters(linuxParameters) .logging(logDriver) .memoryLimitMiB(123) .memoryReservationMiB(123) .portMappings(List.of(PortMapping.builder() .containerPort(123) // the properties below are optional .appProtocol(appProtocol) .containerPortRange("containerPortRange") .hostPort(123) .name("name") .protocol(Protocol.TCP) .build())) .privileged(false) .pseudoTerminal(false) .readonlyRootFilesystem(false) .restartAttemptPeriod(Duration.minutes(30)) .restartIgnoredExitCodes(List.of(123)) .secrets(Map.of( "secretsKey", secret)) .startTimeout(Duration.minutes(30)) .stopTimeout(Duration.minutes(30)) .systemControls(List.of(SystemControl.builder() .namespace("namespace") .value("value") .build())) .ulimits(List.of(Ulimit.builder() .hardLimit(123) .name(UlimitName.CORE) .softLimit(123) .build())) .user("user") .workingDirectory("workingDirectory") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forContainerDefinitionProps
static final class
An implementation forContainerDefinitionProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The name of the task definition that includes this container definition.Methods inherited from interface software.amazon.awscdk.services.ecs.ContainerDefinitionOptions
getCommand, getContainerName, getCpu, getCredentialSpecs, getDisableNetworking, getDnsSearchDomains, getDnsServers, getDockerLabels, getDockerSecurityOptions, getEnableRestartPolicy, getEntryPoint, getEnvironment, getEnvironmentFiles, getEssential, getExtraHosts, getGpuCount, getHealthCheck, getHostname, getImage, getInferenceAcceleratorResources, getInteractive, getLinuxParameters, getLogging, getMemoryLimitMiB, getMemoryReservationMiB, getPortMappings, getPrivileged, getPseudoTerminal, getReadonlyRootFilesystem, getRestartAttemptPeriod, getRestartIgnoredExitCodes, getSecrets, getStartTimeout, getStopTimeout, getSystemControls, getUlimits, getUser, getWorkingDirectory
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getTaskDefinition
The name of the task definition that includes this container definition.[disable-awslint:ref-via-interface]
-
builder
- Returns:
- a
ContainerDefinitionProps.Builder
ofContainerDefinitionProps
-