@Generated(value="software.amazon.awssdk:codegen") public final class AwsEcsTaskDefinitionContainerDefinitionsDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsDetails>
A container definition that describes a container in the task.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
static AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder |
builder() |
List<String> |
command()
The command that is passed to the container.
|
Integer |
cpu()
The number of CPU units reserved for the container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails> |
dependsOn()
The dependencies that are defined for container startup and shutdown.
|
Boolean |
disableNetworking()
Whether to disable networking within the container.
|
List<String> |
dnsSearchDomains()
A list of DNS search domains that are presented to the container.
|
List<String> |
dnsServers()
A list of DNS servers that are presented to the container.
|
Map<String,String> |
dockerLabels()
A key-value map of labels to add to the container.
|
List<String> |
dockerSecurityOptions()
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
|
List<String> |
entryPoint()
The entry point that is passed to the container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails> |
environment()
The environment variables to pass to a container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails> |
environmentFiles()
A list of files containing the environment variables to pass to a container.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Boolean |
essential()
Whether the container is essential.
|
List<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails> |
extraHosts()
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
|
AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails |
firelensConfiguration()
The FireLens configuration for the container.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCommand()
For responses, this returns true if the service returned a value for the Command property.
|
boolean |
hasDependsOn()
For responses, this returns true if the service returned a value for the DependsOn property.
|
boolean |
hasDnsSearchDomains()
For responses, this returns true if the service returned a value for the DnsSearchDomains property.
|
boolean |
hasDnsServers()
For responses, this returns true if the service returned a value for the DnsServers property.
|
boolean |
hasDockerLabels()
For responses, this returns true if the service returned a value for the DockerLabels property.
|
boolean |
hasDockerSecurityOptions()
For responses, this returns true if the service returned a value for the DockerSecurityOptions property.
|
boolean |
hasEntryPoint()
For responses, this returns true if the service returned a value for the EntryPoint property.
|
boolean |
hasEnvironment()
For responses, this returns true if the service returned a value for the Environment property.
|
boolean |
hasEnvironmentFiles()
For responses, this returns true if the service returned a value for the EnvironmentFiles property.
|
boolean |
hasExtraHosts()
For responses, this returns true if the service returned a value for the ExtraHosts property.
|
int |
hashCode() |
boolean |
hasLinks()
For responses, this returns true if the service returned a value for the Links property.
|
boolean |
hasMountPoints()
For responses, this returns true if the service returned a value for the MountPoints property.
|
boolean |
hasPortMappings()
For responses, this returns true if the service returned a value for the PortMappings property.
|
boolean |
hasResourceRequirements()
For responses, this returns true if the service returned a value for the ResourceRequirements property.
|
boolean |
hasSecrets()
For responses, this returns true if the service returned a value for the Secrets property.
|
boolean |
hasSystemControls()
For responses, this returns true if the service returned a value for the SystemControls property.
|
boolean |
hasUlimits()
For responses, this returns true if the service returned a value for the Ulimits property.
|
boolean |
hasVolumesFrom()
For responses, this returns true if the service returned a value for the VolumesFrom property.
|
AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails |
healthCheck()
The container health check command and associated configuration parameters for the container.
|
String |
hostname()
The hostname to use for the container.
|
String |
image()
The image used to start the container.
|
Boolean |
interactive()
If set to true, then containerized applications can be deployed that require
stdin or a
tty to be allocated. |
List<String> |
links()
A list of links for the container in the form
container_name:alias . |
AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails |
linuxParameters()
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
|
AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails |
logConfiguration()
The log configuration specification for the container.
|
Integer |
memory()
The amount (in MiB) of memory to present to the container.
|
Integer |
memoryReservation()
The soft limit (in MiB) of memory to reserve for the container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails> |
mountPoints()
The mount points for the data volumes in the container.
|
String |
name()
The name of the container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails> |
portMappings()
The list of port mappings for the container.
|
Boolean |
privileged()
Whether the container is given elevated privileges on the host container instance.
|
Boolean |
pseudoTerminal()
Whether to allocate a TTY to the container.
|
Boolean |
readonlyRootFilesystem()
Whether the container is given read-only access to its root file system.
|
AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails |
repositoryCredentials()
The private repository authentication credentials to use.
|
List<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails> |
resourceRequirements()
The type and amount of a resource to assign to a container.
|
List<SdkField<?>> |
sdkFields() |
List<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails> |
secrets()
The secrets to pass to the container.
|
static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder> |
serializableBuilderClass() |
Integer |
startTimeout()
The number of seconds to wait before giving up on resolving dependencies for a container.
|
Integer |
stopTimeout()
The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.
|
List<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails> |
systemControls()
A list of namespaced kernel parameters to set in the container.
|
AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails> |
ulimits()
A list of ulimits to set in the container.
|
String |
user()
The user to use inside the container.
|
List<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails> |
volumesFrom()
Data volumes to mount from another container.
|
String |
workingDirectory()
The working directory in which to run commands inside the container.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasCommand()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> command()
The command that is passed to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCommand() method.
public final Integer cpu()
The number of CPU units reserved for the container.
public final boolean hasDependsOn()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails> dependsOn()
The dependencies that are defined for container startup and shutdown.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDependsOn() method.
public final Boolean disableNetworking()
Whether to disable networking within the container.
public final boolean hasDnsSearchDomains()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> dnsSearchDomains()
A list of DNS search domains that are presented to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDnsSearchDomains() method.
public final boolean hasDnsServers()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> dnsServers()
A list of DNS servers that are presented to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDnsServers() method.
public final boolean hasDockerLabels()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final Map<String,String> dockerLabels()
A key-value map of labels to add to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDockerLabels() method.
public final boolean hasDockerSecurityOptions()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> dockerSecurityOptions()
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDockerSecurityOptions() method.
public final boolean hasEntryPoint()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> entryPoint()
The entry point that is passed to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEntryPoint() method.
public final boolean hasEnvironment()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails> environment()
The environment variables to pass to a container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnvironment() method.
public final boolean hasEnvironmentFiles()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails> environmentFiles()
A list of files containing the environment variables to pass to a container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnvironmentFiles() method.
public final Boolean essential()
Whether the container is essential. All tasks must have at least one essential container.
public final boolean hasExtraHosts()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails> extraHosts()
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExtraHosts() method.
public final AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails firelensConfiguration()
The FireLens configuration for the container. Specifies and configures a log router for container logs.
public final AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails healthCheck()
The container health check command and associated configuration parameters for the container.
public final String hostname()
The hostname to use for the container.
public final String image()
The image used to start the container.
public final Boolean interactive()
If set to true, then containerized applications can be deployed that require stdin or a
tty to be allocated.
stdin or a
tty to be allocated.public final boolean hasLinks()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<String> links()
A list of links for the container in the form container_name:alias . Allows
containers to communicate with each other without the need for port mappings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLinks() method.
container_name:alias . Allows
containers to communicate with each other without the need for port mappings.public final AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails linuxParameters()
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
public final AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails logConfiguration()
The log configuration specification for the container.
public final Integer memory()
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.
public final Integer memoryReservation()
The soft limit (in MiB) of memory to reserve for the container.
public final boolean hasMountPoints()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails> mountPoints()
The mount points for the data volumes in the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMountPoints() method.
public final String name()
The name of the container.
public final boolean hasPortMappings()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails> portMappings()
The list of port mappings for the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPortMappings() method.
public final Boolean privileged()
Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.
public final Boolean pseudoTerminal()
Whether to allocate a TTY to the container.
public final Boolean readonlyRootFilesystem()
Whether the container is given read-only access to its root file system.
public final AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails repositoryCredentials()
The private repository authentication credentials to use.
public final boolean hasResourceRequirements()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails> resourceRequirements()
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResourceRequirements() method.
public final boolean hasSecrets()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails> secrets()
The secrets to pass to the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSecrets() method.
public final Integer startTimeout()
The number of seconds to wait before giving up on resolving dependencies for a container.
public final Integer stopTimeout()
The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.
public final boolean hasSystemControls()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails> systemControls()
A list of namespaced kernel parameters to set in the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSystemControls() method.
public final boolean hasUlimits()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails> ulimits()
A list of ulimits to set in the container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasUlimits() method.
public final String user()
The user to use inside the container.
The value can use one of the following formats.
user
user : group
uid
uid : gid
user : gid
uid : group
The value can use one of the following formats.
user
user : group
uid
uid : gid
user : gid
uid : group
public final boolean hasVolumesFrom()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails> volumesFrom()
Data volumes to mount from another container.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVolumesFrom() method.
public final String workingDirectory()
The working directory in which to run commands inside the container.
public AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder toBuilder()
public static AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder builder()
public static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.