software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.ContainerDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.ContainerDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(value=Stable)
public static interface CfnTaskDefinition.ContainerDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ContainerDefinitionProperty containerDefinitionProperty = ContainerDefinitionProperty.builder()
         .command(List.of("command"))
         .cpu(123)
         .dependsOn(List.of(ContainerDependencyProperty.builder()
                 .condition("condition")
                 .containerName("containerName")
                 .build()))
         .disableNetworking(false)
         .dnsSearchDomains(List.of("dnsSearchDomains"))
         .dnsServers(List.of("dnsServers"))
         .dockerLabels(Map.of(
                 "dockerLabelsKey", "dockerLabels"))
         .dockerSecurityOptions(List.of("dockerSecurityOptions"))
         .entryPoint(List.of("entryPoint"))
         .environment(List.of(KeyValuePairProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .environmentFiles(List.of(EnvironmentFileProperty.builder()
                 .type("type")
                 .value("value")
                 .build()))
         .essential(false)
         .extraHosts(List.of(HostEntryProperty.builder()
                 .hostname("hostname")
                 .ipAddress("ipAddress")
                 .build()))
         .firelensConfiguration(FirelensConfigurationProperty.builder()
                 .options(Map.of(
                         "optionsKey", "options"))
                 .type("type")
                 .build())
         .healthCheck(HealthCheckProperty.builder()
                 .command(List.of("command"))
                 .interval(123)
                 .retries(123)
                 .startPeriod(123)
                 .timeout(123)
                 .build())
         .hostname("hostname")
         .image("image")
         .interactive(false)
         .links(List.of("links"))
         .linuxParameters(LinuxParametersProperty.builder()
                 .capabilities(KernelCapabilitiesProperty.builder()
                         .add(List.of("add"))
                         .drop(List.of("drop"))
                         .build())
                 .devices(List.of(DeviceProperty.builder()
                         .containerPath("containerPath")
                         .hostPath("hostPath")
                         .permissions(List.of("permissions"))
                         .build()))
                 .initProcessEnabled(false)
                 .maxSwap(123)
                 .sharedMemorySize(123)
                 .swappiness(123)
                 .tmpfs(List.of(TmpfsProperty.builder()
                         .size(123)
                         // the properties below are optional
                         .containerPath("containerPath")
                         .mountOptions(List.of("mountOptions"))
                         .build()))
                 .build())
         .logConfiguration(LogConfigurationProperty.builder()
                 .logDriver("logDriver")
                 // the properties below are optional
                 .options(Map.of(
                         "optionsKey", "options"))
                 .secretOptions(List.of(SecretProperty.builder()
                         .name("name")
                         .valueFrom("valueFrom")
                         .build()))
                 .build())
         .memory(123)
         .memoryReservation(123)
         .mountPoints(List.of(MountPointProperty.builder()
                 .containerPath("containerPath")
                 .readOnly(false)
                 .sourceVolume("sourceVolume")
                 .build()))
         .name("name")
         .portMappings(List.of(PortMappingProperty.builder()
                 .containerPort(123)
                 .hostPort(123)
                 .protocol("protocol")
                 .build()))
         .privileged(false)
         .pseudoTerminal(false)
         .readonlyRootFilesystem(false)
         .repositoryCredentials(RepositoryCredentialsProperty.builder()
                 .credentialsParameter("credentialsParameter")
                 .build())
         .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                 .type("type")
                 .value("value")
                 .build()))
         .secrets(List.of(SecretProperty.builder()
                 .name("name")
                 .valueFrom("valueFrom")
                 .build()))
         .startTimeout(123)
         .stopTimeout(123)
         .systemControls(List.of(SystemControlProperty.builder()
                 .namespace("namespace")
                 .value("value")
                 .build()))
         .ulimits(List.of(UlimitProperty.builder()
                 .hardLimit(123)
                 .name("name")
                 .softLimit(123)
                 .build()))
         .user("user")
         .volumesFrom(List.of(VolumeFromProperty.builder()
                 .readOnly(false)
                 .sourceContainer("sourceContainer")
                 .build()))
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTaskDefinition.ContainerDefinitionProperty.Builder A builder for CfnTaskDefinition.ContainerDefinitionProperty
static class	CfnTaskDefinition.ContainerDefinitionProperty.Jsii$Proxy An implementation for CfnTaskDefinition.ContainerDefinitionProperty

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.ContainerDefinitionProperty.Builder	builder()
default List<String>	getCommand() `CfnTaskDefinition.ContainerDefinitionProperty.Command`.
default Number	getCpu() `CfnTaskDefinition.ContainerDefinitionProperty.Cpu`.
default Object	getDependsOn() `CfnTaskDefinition.ContainerDefinitionProperty.DependsOn`.
default Object	getDisableNetworking() `CfnTaskDefinition.ContainerDefinitionProperty.DisableNetworking`.
default List<String>	getDnsSearchDomains() `CfnTaskDefinition.ContainerDefinitionProperty.DnsSearchDomains`.
default List<String>	getDnsServers() `CfnTaskDefinition.ContainerDefinitionProperty.DnsServers`.
default Object	getDockerLabels() `CfnTaskDefinition.ContainerDefinitionProperty.DockerLabels`.
default List<String>	getDockerSecurityOptions() `CfnTaskDefinition.ContainerDefinitionProperty.DockerSecurityOptions`.
default List<String>	getEntryPoint() `CfnTaskDefinition.ContainerDefinitionProperty.EntryPoint`.
default Object	getEnvironment() `CfnTaskDefinition.ContainerDefinitionProperty.Environment`.
default Object	getEnvironmentFiles() `CfnTaskDefinition.ContainerDefinitionProperty.EnvironmentFiles`.
default Object	getEssential() `CfnTaskDefinition.ContainerDefinitionProperty.Essential`.
default Object	getExtraHosts() `CfnTaskDefinition.ContainerDefinitionProperty.ExtraHosts`.
default Object	getFirelensConfiguration() `CfnTaskDefinition.ContainerDefinitionProperty.FirelensConfiguration`.
default Object	getHealthCheck() `CfnTaskDefinition.ContainerDefinitionProperty.HealthCheck`.
default String	getHostname() `CfnTaskDefinition.ContainerDefinitionProperty.Hostname`.
default String	getImage() `CfnTaskDefinition.ContainerDefinitionProperty.Image`.
default Object	getInteractive() `CfnTaskDefinition.ContainerDefinitionProperty.Interactive`.
default List<String>	getLinks() `CfnTaskDefinition.ContainerDefinitionProperty.Links`.
default Object	getLinuxParameters() `CfnTaskDefinition.ContainerDefinitionProperty.LinuxParameters`.
default Object	getLogConfiguration() `CfnTaskDefinition.ContainerDefinitionProperty.LogConfiguration`.
default Number	getMemory() `CfnTaskDefinition.ContainerDefinitionProperty.Memory`.
default Number	getMemoryReservation() `CfnTaskDefinition.ContainerDefinitionProperty.MemoryReservation`.
default Object	getMountPoints() `CfnTaskDefinition.ContainerDefinitionProperty.MountPoints`.
default String	getName() `CfnTaskDefinition.ContainerDefinitionProperty.Name`.
default Object	getPortMappings() `CfnTaskDefinition.ContainerDefinitionProperty.PortMappings`.
default Object	getPrivileged() `CfnTaskDefinition.ContainerDefinitionProperty.Privileged`.
default Object	getPseudoTerminal() `CfnTaskDefinition.ContainerDefinitionProperty.PseudoTerminal`.
default Object	getReadonlyRootFilesystem() `CfnTaskDefinition.ContainerDefinitionProperty.ReadonlyRootFilesystem`.
default Object	getRepositoryCredentials() `CfnTaskDefinition.ContainerDefinitionProperty.RepositoryCredentials`.
default Object	getResourceRequirements() `CfnTaskDefinition.ContainerDefinitionProperty.ResourceRequirements`.
default Object	getSecrets() `CfnTaskDefinition.ContainerDefinitionProperty.Secrets`.
default Number	getStartTimeout() `CfnTaskDefinition.ContainerDefinitionProperty.StartTimeout`.
default Number	getStopTimeout() `CfnTaskDefinition.ContainerDefinitionProperty.StopTimeout`.
default Object	getSystemControls() `CfnTaskDefinition.ContainerDefinitionProperty.SystemControls`.
default Object	getUlimits() `CfnTaskDefinition.ContainerDefinitionProperty.Ulimits`.
default String	getUser() `CfnTaskDefinition.ContainerDefinitionProperty.User`.
default Object	getVolumesFrom() `CfnTaskDefinition.ContainerDefinitionProperty.VolumesFrom`.
default String	getWorkingDirectory() `CfnTaskDefinition.ContainerDefinitionProperty.WorkingDirectory`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

@Stability(value=Stable)
 @Nullable
default List<String> getCommand()

`CfnTaskDefinition.ContainerDefinitionProperty.Command`.

getCpu

@Stability(value=Stable)
 @Nullable
default Number getCpu()

`CfnTaskDefinition.ContainerDefinitionProperty.Cpu`.

getDependsOn

@Stability(value=Stable)
 @Nullable
default Object getDependsOn()

`CfnTaskDefinition.ContainerDefinitionProperty.DependsOn`.

getDisableNetworking

@Stability(value=Stable)
 @Nullable
default Object getDisableNetworking()

`CfnTaskDefinition.ContainerDefinitionProperty.DisableNetworking`.

getDnsSearchDomains

@Stability(value=Stable)
 @Nullable
default List<String> getDnsSearchDomains()

`CfnTaskDefinition.ContainerDefinitionProperty.DnsSearchDomains`.

getDnsServers

@Stability(value=Stable)
 @Nullable
default List<String> getDnsServers()

`CfnTaskDefinition.ContainerDefinitionProperty.DnsServers`.

getDockerLabels

@Stability(value=Stable)
 @Nullable
default Object getDockerLabels()

`CfnTaskDefinition.ContainerDefinitionProperty.DockerLabels`.

getDockerSecurityOptions

@Stability(value=Stable)
 @Nullable
default List<String> getDockerSecurityOptions()

`CfnTaskDefinition.ContainerDefinitionProperty.DockerSecurityOptions`.

getEntryPoint

@Stability(value=Stable)
 @Nullable
default List<String> getEntryPoint()

`CfnTaskDefinition.ContainerDefinitionProperty.EntryPoint`.

getEnvironment

@Stability(value=Stable)
 @Nullable
default Object getEnvironment()

`CfnTaskDefinition.ContainerDefinitionProperty.Environment`.

getEnvironmentFiles

@Stability(value=Stable)
 @Nullable
default Object getEnvironmentFiles()

`CfnTaskDefinition.ContainerDefinitionProperty.EnvironmentFiles`.

getEssential

@Stability(value=Stable)
 @Nullable
default Object getEssential()

`CfnTaskDefinition.ContainerDefinitionProperty.Essential`.

getExtraHosts

@Stability(value=Stable)
 @Nullable
default Object getExtraHosts()

`CfnTaskDefinition.ContainerDefinitionProperty.ExtraHosts`.

getFirelensConfiguration

@Stability(value=Stable)
 @Nullable
default Object getFirelensConfiguration()

`CfnTaskDefinition.ContainerDefinitionProperty.FirelensConfiguration`.

getHealthCheck

@Stability(value=Stable)
 @Nullable
default Object getHealthCheck()

`CfnTaskDefinition.ContainerDefinitionProperty.HealthCheck`.

getHostname

@Stability(value=Stable)
 @Nullable
default String getHostname()

`CfnTaskDefinition.ContainerDefinitionProperty.Hostname`.

getImage

@Stability(value=Stable)
 @Nullable
default String getImage()

`CfnTaskDefinition.ContainerDefinitionProperty.Image`.

getInteractive

@Stability(value=Stable)
 @Nullable
default Object getInteractive()

`CfnTaskDefinition.ContainerDefinitionProperty.Interactive`.

getLinks

@Stability(value=Stable)
 @Nullable
default List<String> getLinks()

`CfnTaskDefinition.ContainerDefinitionProperty.Links`.

getLinuxParameters

@Stability(value=Stable)
 @Nullable
default Object getLinuxParameters()

`CfnTaskDefinition.ContainerDefinitionProperty.LinuxParameters`.

getLogConfiguration

@Stability(value=Stable)
 @Nullable
default Object getLogConfiguration()

`CfnTaskDefinition.ContainerDefinitionProperty.LogConfiguration`.

getMemory

@Stability(value=Stable)
 @Nullable
default Number getMemory()

`CfnTaskDefinition.ContainerDefinitionProperty.Memory`.

getMemoryReservation

@Stability(value=Stable)
 @Nullable
default Number getMemoryReservation()

`CfnTaskDefinition.ContainerDefinitionProperty.MemoryReservation`.

getMountPoints

@Stability(value=Stable)
 @Nullable
default Object getMountPoints()

`CfnTaskDefinition.ContainerDefinitionProperty.MountPoints`.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`CfnTaskDefinition.ContainerDefinitionProperty.Name`.

getPortMappings

@Stability(value=Stable)
 @Nullable
default Object getPortMappings()

`CfnTaskDefinition.ContainerDefinitionProperty.PortMappings`.

getPrivileged

@Stability(value=Stable)
 @Nullable
default Object getPrivileged()

`CfnTaskDefinition.ContainerDefinitionProperty.Privileged`.

getPseudoTerminal

@Stability(value=Stable)
 @Nullable
default Object getPseudoTerminal()

`CfnTaskDefinition.ContainerDefinitionProperty.PseudoTerminal`.

getReadonlyRootFilesystem

@Stability(value=Stable)
 @Nullable
default Object getReadonlyRootFilesystem()

`CfnTaskDefinition.ContainerDefinitionProperty.ReadonlyRootFilesystem`.

getRepositoryCredentials

@Stability(value=Stable)
 @Nullable
default Object getRepositoryCredentials()

`CfnTaskDefinition.ContainerDefinitionProperty.RepositoryCredentials`.

getResourceRequirements

@Stability(value=Stable)
 @Nullable
default Object getResourceRequirements()

`CfnTaskDefinition.ContainerDefinitionProperty.ResourceRequirements`.

getSecrets

@Stability(value=Stable)
 @Nullable
default Object getSecrets()

`CfnTaskDefinition.ContainerDefinitionProperty.Secrets`.

getStartTimeout

@Stability(value=Stable)
 @Nullable
default Number getStartTimeout()

`CfnTaskDefinition.ContainerDefinitionProperty.StartTimeout`.

getStopTimeout

@Stability(value=Stable)
 @Nullable
default Number getStopTimeout()

`CfnTaskDefinition.ContainerDefinitionProperty.StopTimeout`.

getSystemControls

@Stability(value=Stable)
 @Nullable
default Object getSystemControls()

`CfnTaskDefinition.ContainerDefinitionProperty.SystemControls`.

getUlimits

@Stability(value=Stable)
 @Nullable
default Object getUlimits()

`CfnTaskDefinition.ContainerDefinitionProperty.Ulimits`.

getUser

@Stability(value=Stable)
 @Nullable
default String getUser()

`CfnTaskDefinition.ContainerDefinitionProperty.User`.

getVolumesFrom

@Stability(value=Stable)
 @Nullable
default Object getVolumesFrom()

`CfnTaskDefinition.ContainerDefinitionProperty.VolumesFrom`.

getWorkingDirectory

@Stability(value=Stable)
 @Nullable
default String getWorkingDirectory()

`CfnTaskDefinition.ContainerDefinitionProperty.WorkingDirectory`.

builder

@Stability(value=Stable)
static CfnTaskDefinition.ContainerDefinitionProperty.Builder builder()

Returns:

a CfnTaskDefinition.ContainerDefinitionProperty.Builder of CfnTaskDefinition.ContainerDefinitionProperty