Package software.amazon.awssdk.services.securityhub.model

Class AwsEcsTaskDefinitionContainerDefinitionsDetails

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsEcsTaskDefinitionContainerDefinitionsDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsDetails>
@Generated("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.

See Also:

  • Method Details

    • hasCommand

      public final boolean hasCommand()
      For responses, this returns true if the service returned a value for the Command property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • command

      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.

      Returns:
      The command that is passed to the container.

    • cpu

      public final Integer cpu()

      The number of CPU units reserved for the container.

      Returns:
      The number of CPU units reserved for the container.

    • hasDependsOn

      public final boolean hasDependsOn()
      For responses, this returns true if the service returned a value for the DependsOn property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • dependsOn

      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.

      Returns:
      The dependencies that are defined for container startup and shutdown.

    • disableNetworking

      public final Boolean disableNetworking()

      Whether to disable networking within the container.

      Returns:
      Whether to disable networking within the container.

    • hasDnsSearchDomains

      public final boolean hasDnsSearchDomains()
      For responses, this returns true if the service returned a value for the DnsSearchDomains property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • dnsSearchDomains

      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.

      Returns:
      A list of DNS search domains that are presented to the container.

    • hasDnsServers

      public final boolean hasDnsServers()
      For responses, this returns true if the service returned a value for the DnsServers property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • dnsServers

      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.

      Returns:
      A list of DNS servers that are presented to the container.

    • hasDockerLabels

      public final boolean hasDockerLabels()
      For responses, this returns true if the service returned a value for the DockerLabels property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • dockerLabels

      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.

      Returns:
      A key-value map of labels to add to the container.

    • hasDockerSecurityOptions

      public final boolean hasDockerSecurityOptions()
      For responses, this returns true if the service returned a value for the DockerSecurityOptions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • dockerSecurityOptions

      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.

      Returns:
      A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

    • hasEntryPoint

      public final boolean hasEntryPoint()
      For responses, this returns true if the service returned a value for the EntryPoint property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • entryPoint

      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.

      Returns:
      The entry point that is passed to the container.

    • hasEnvironment

      public final boolean hasEnvironment()
      For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • environment

      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.

      Returns:
      The environment variables to pass to a container.

    • hasEnvironmentFiles

      public final boolean hasEnvironmentFiles()
      For responses, this returns true if the service returned a value for the EnvironmentFiles property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • environmentFiles

      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.

      Returns:
      A list of files containing the environment variables to pass to a container.

    • essential

      public final Boolean essential()

      Whether the container is essential. All tasks must have at least one essential container.

      Returns:
      Whether the container is essential. All tasks must have at least one essential container.

    • hasExtraHosts

      public final boolean hasExtraHosts()
      For responses, this returns true if the service returned a value for the ExtraHosts property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • extraHosts

      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.

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

    • firelensConfiguration

      public final AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails firelensConfiguration()

      The FireLens configuration for the container. Specifies and configures a log router for container logs.

      Returns:
      The FireLens configuration for the container. Specifies and configures a log router for container logs.

    • healthCheck

      public final AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails healthCheck()

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

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

    • hostname

      public final String hostname()

      The hostname to use for the container.

      Returns:
      The hostname to use for the container.

    • image

      public final String image()

      The image used to start the container.

      Returns:
      The image used to start the container.

    • interactive

      public final Boolean interactive()

      If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

      Returns:
      If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.

    • hasLinks

      public final boolean hasLinks()
      For responses, this returns true if the service returned a value for the Links property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • links

      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.

      Returns:
      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.

    • linuxParameters

      public final AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails linuxParameters()

      Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

      Returns:
      Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.

    • logConfiguration

      public final AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails logConfiguration()

      The log configuration specification for the container.

      Returns:
      The log configuration specification for the container.

    • memory

      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.

      Returns:
      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.

    • memoryReservation

      public final Integer memoryReservation()

      The soft limit (in MiB) of memory to reserve for the container.

      Returns:
      The soft limit (in MiB) of memory to reserve for the container.

    • hasMountPoints

      public final boolean hasMountPoints()
      For responses, this returns true if the service returned a value for the MountPoints property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • mountPoints

      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.

      Returns:
      The mount points for the data volumes in the container.

    • name

      public final String name()

      The name of the container.

      Returns:
      The name of the container.

    • hasPortMappings

      public final boolean hasPortMappings()
      For responses, this returns true if the service returned a value for the PortMappings property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • portMappings

      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.

      Returns:
      The list of port mappings for the container.

    • privileged

      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.

      Returns:
      Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.

    • pseudoTerminal

      public final Boolean pseudoTerminal()

      Whether to allocate a TTY to the container.

      Returns:
      Whether to allocate a TTY to the container.

    • readonlyRootFilesystem

      public final Boolean readonlyRootFilesystem()

      Whether the container is given read-only access to its root file system.

      Returns:
      Whether the container is given read-only access to its root file system.

    • repositoryCredentials

      public final AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails repositoryCredentials()

      The private repository authentication credentials to use.

      Returns:
      The private repository authentication credentials to use.

    • hasResourceRequirements

      public final boolean hasResourceRequirements()
      For responses, this returns true if the service returned a value for the ResourceRequirements property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • resourceRequirements

      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.

      Returns:
      The type and amount of a resource to assign to a container. The only supported resource is a GPU.

    • hasSecrets

      public final boolean hasSecrets()
      For responses, this returns true if the service returned a value for the Secrets property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • secrets

      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.

      Returns:
      The secrets to pass to the container.

    • startTimeout

      public final Integer startTimeout()

      The number of seconds to wait before giving up on resolving dependencies for a container.

      Returns:
      The number of seconds to wait before giving up on resolving dependencies for a container.

    • stopTimeout

      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.

      Returns:
      The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.

    • hasSystemControls

      public final boolean hasSystemControls()
      For responses, this returns true if the service returned a value for the SystemControls property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • systemControls

      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.

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

    • hasUlimits

      public final boolean hasUlimits()
      For responses, this returns true if the service returned a value for the Ulimits property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • ulimits

      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.

      Returns:
      A list of ulimits to set in the container.

    • user

      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

      Returns:
      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

    • hasVolumesFrom

      public final boolean hasVolumesFrom()
      For responses, this returns true if the service returned a value for the VolumesFrom property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • volumesFrom

      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.

      Returns:
      Data volumes to mount from another container.

    • workingDirectory

      public final String workingDirectory()

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

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

    • toBuilder

      public AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder,AwsEcsTaskDefinitionContainerDefinitionsDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsEcsTaskDefinitionContainerDefinitionsDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.