Interface ContainerProperties.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ContainerProperties.Builder,
,ContainerProperties> SdkBuilder<ContainerProperties.Builder,
,ContainerProperties> SdkPojo
- Enclosing class:
ContainerProperties
-
Method Summary
Modifier and TypeMethodDescriptionThe command that's passed to the container.command
(Collection<String> command) The command that's passed to the container.environment
(Collection<KeyValuePair> environment) The environment variables to pass to a container.environment
(Consumer<KeyValuePair.Builder>... environment) The environment variables to pass to a container.environment
(KeyValuePair... environment) The environment variables to pass to a container.default ContainerProperties.Builder
ephemeralStorage
(Consumer<EphemeralStorage.Builder> ephemeralStorage) The amount of ephemeral storage to allocate for the task.ephemeralStorage
(EphemeralStorage ephemeralStorage) The amount of ephemeral storage to allocate for the task.executionRoleArn
(String executionRoleArn) The Amazon Resource Name (ARN) of the execution role that Batch can assume.default ContainerProperties.Builder
fargatePlatformConfiguration
(Consumer<FargatePlatformConfiguration.Builder> fargatePlatformConfiguration) The platform configuration for jobs that are running on Fargate resources.fargatePlatformConfiguration
(FargatePlatformConfiguration fargatePlatformConfiguration) The platform configuration for jobs that are running on Fargate resources.Required.instanceType
(String instanceType) The instance type to use for a multi-node parallel job.jobRoleArn
(String jobRoleArn) The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions.default ContainerProperties.Builder
linuxParameters
(Consumer<LinuxParameters.Builder> linuxParameters) Linux-specific modifications that are applied to the container, such as details for device mappings.linuxParameters
(LinuxParameters linuxParameters) Linux-specific modifications that are applied to the container, such as details for device mappings.default ContainerProperties.Builder
logConfiguration
(Consumer<LogConfiguration.Builder> logConfiguration) The log configuration specification for the container.logConfiguration
(LogConfiguration logConfiguration) The log configuration specification for the container.Deprecated.This field is deprecated, use resourceRequirements instead.mountPoints
(Collection<MountPoint> mountPoints) The mount points for data volumes in your container.mountPoints
(Consumer<MountPoint.Builder>... mountPoints) The mount points for data volumes in your container.mountPoints
(MountPoint... mountPoints) The mount points for data volumes in your container.default ContainerProperties.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) The network configuration for jobs that are running on Fargate resources.networkConfiguration
(NetworkConfiguration networkConfiguration) The network configuration for jobs that are running on Fargate resources.privileged
(Boolean privileged) When this parameter is true, the container is given elevated permissions on the host container instance (similar to theroot
user).readonlyRootFilesystem
(Boolean readonlyRootFilesystem) When this parameter is true, the container is given read-only access to its root file system.default ContainerProperties.Builder
repositoryCredentials
(Consumer<RepositoryCredentials.Builder> repositoryCredentials) The private repository authentication credentials to use.repositoryCredentials
(RepositoryCredentials repositoryCredentials) The private repository authentication credentials to use.resourceRequirements
(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.resourceRequirements
(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container.resourceRequirements
(ResourceRequirement... resourceRequirements) The type and amount of resources to assign to a container.default ContainerProperties.Builder
runtimePlatform
(Consumer<RuntimePlatform.Builder> runtimePlatform) An object that represents the compute environment architecture for Batch jobs on Fargate.runtimePlatform
(RuntimePlatform runtimePlatform) An object that represents the compute environment architecture for Batch jobs on Fargate.secrets
(Collection<Secret> secrets) The secrets for the container.secrets
(Consumer<Secret.Builder>... secrets) The secrets for the container.The secrets for the container.ulimits
(Collection<Ulimit> ulimits) A list ofulimits
to set in the container.ulimits
(Consumer<Ulimit.Builder>... ulimits) A list ofulimits
to set in the container.A list ofulimits
to set in the container.The user name to use inside the container.Deprecated.This field is deprecated, use resourceRequirements instead.volumes
(Collection<Volume> volumes) A list of data volumes used in a job.volumes
(Consumer<Volume.Builder>... volumes) A list of data volumes used in a job.A list of data volumes used in a job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
image
Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with
repository-url/image:tag
. It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps toImage
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker run.Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
-
Images in Amazon ECR Public repositories use the full
registry/repository[:tag]
orregistry/repository[@digest]
naming conventions. For example,public.ecr.aws/registry_alias/my-web-app:latest
. -
Images in Amazon ECR repositories use the full registry and repository URI (for example,
123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
). -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
- Parameters:
image
- Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified withrepository-url/image:tag
. It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps toImage
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker run.Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
-
Images in Amazon ECR Public repositories use the full
registry/repository[:tag]
orregistry/repository[@digest]
naming conventions. For example,public.ecr.aws/registry_alias/my-web-app:latest
. -
Images in Amazon ECR repositories use the full registry and repository URI (for example,
123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>
). -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
vcpus
Deprecated.This field is deprecated, use resourceRequirements instead.This parameter is deprecated, use
resourceRequirements
to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.- Parameters:
vcpus
- This parameter is deprecated, useresourceRequirements
to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to
CpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memory
Deprecated.This field is deprecated, use resourceRequirements instead.This parameter is deprecated, use
resourceRequirements
to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.- Parameters:
memory
- This parameter is deprecated, useresourceRequirements
to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
The command that's passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.- Parameters:
command
- The command that's passed to the container. This parameter maps toCmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run. For more information, see https ://docs.docker.com/engine/reference/builder/#cmd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
The command that's passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.- Parameters:
command
- The command that's passed to the container. This parameter maps toCmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run. For more information, see https ://docs.docker.com/engine/reference/builder/#cmd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobRoleArn
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.
- Parameters:
jobRoleArn
- The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionRoleArn
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
- Parameters:
executionRoleArn
- The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumes
A list of data volumes used in a job.
- Parameters:
volumes
- A list of data volumes used in a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumes
A list of data volumes used in a job.
- Parameters:
volumes
- A list of data volumes used in a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumes
A list of data volumes used in a job.
This is a convenience method that creates an instance of theVolume.Builder
avoiding the need to create one manually viaVolume.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovolumes(List<Volume>)
.- Parameters:
volumes
- a consumer that will call methods onVolume.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environment
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run.We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Parameters:
environment
- The environment variables to pass to a container. This parameter maps toEnv
in the Create a container section of the Docker Remote API and the--env
option to docker run.We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environment
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run.We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Parameters:
environment
- The environment variables to pass to a container. This parameter maps toEnv
in the Create a container section of the Docker Remote API and the--env
option to docker run.We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environment
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run.We don't recommend using plaintext environment variables for sensitive information, such as credential data.
Environment variables cannot start with "
AWS_BATCH
". This naming convention is reserved for variables that Batch sets.KeyValuePair.Builder
avoiding the need to create one manually viaKeyValuePair.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironment(List<KeyValuePair>)
.- Parameters:
environment
- a consumer that will call methods onKeyValuePair.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
mountPoints
The mount points for data volumes in your container. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.- Parameters:
mountPoints
- The mount points for data volumes in your container. This parameter maps toVolumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mountPoints
The mount points for data volumes in your container. This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.- Parameters:
mountPoints
- The mount points for data volumes in your container. This parameter maps toVolumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mountPoints
The mount points for data volumes in your container. This parameter maps to
This is a convenience method that creates an instance of theVolumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.MountPoint.Builder
avoiding the need to create one manually viaMountPoint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomountPoints(List<MountPoint>)
.- Parameters:
mountPoints
- a consumer that will call methods onMountPoint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
readonlyRootFilesystem
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the--read-only
option todocker run
.- Parameters:
readonlyRootFilesystem
- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfs
in the Create a container section of the Docker Remote API and the--read-only
option todocker run
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privileged
When this parameter is true, the container is given elevated permissions on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run. The default value is false.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
- Parameters:
privileged
- When this parameter is true, the container is given elevated permissions on the host container instance (similar to theroot
user). This parameter maps toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run. The default value is false.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Parameters:
ulimits
- A list ofulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Parameters:
ulimits
- A list ofulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ulimits
A list of
ulimits
to set in the container. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
Ulimit.Builder
avoiding the need to create one manually viaUlimit.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toulimits(List<Ulimit>)
.- Parameters:
ulimits
- a consumer that will call methods onUlimit.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
user
The user name to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the--user
option to docker run.- Parameters:
user
- The user name to use inside the container. This parameter maps toUser
in the Create a container section of the Docker Remote API and the--user
option to docker run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
- Parameters:
instanceType
- The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
ContainerProperties.Builder resourceRequirements(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.- Parameters:
resourceRequirements
- The type and amount of resources to assign to a container. The supported resources includeGPU
,MEMORY
, andVCPU
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
The type and amount of resources to assign to a container. The supported resources include
GPU
,MEMORY
, andVCPU
.- Parameters:
resourceRequirements
- The type and amount of resources to assign to a container. The supported resources includeGPU
,MEMORY
, andVCPU
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceRequirements
ContainerProperties.Builder resourceRequirements(Consumer<ResourceRequirement.Builder>... resourceRequirements) The type and amount of resources to assign to a container. The supported resources include
This is a convenience method that creates an instance of theGPU
,MEMORY
, andVCPU
.ResourceRequirement.Builder
avoiding the need to create one manually viaResourceRequirement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceRequirements(List<ResourceRequirement>)
.- Parameters:
resourceRequirements
- a consumer that will call methods onResourceRequirement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
linuxParameters
Linux-specific modifications that are applied to the container, such as details for device mappings.
- Parameters:
linuxParameters
- Linux-specific modifications that are applied to the container, such as details for device mappings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
linuxParameters
default ContainerProperties.Builder linuxParameters(Consumer<LinuxParameters.Builder> linuxParameters) Linux-specific modifications that are applied to the container, such as details for device mappings.
This is a convenience method that creates an instance of theLinuxParameters.Builder
avoiding the need to create one manually viaLinuxParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolinuxParameters(LinuxParameters)
.- Parameters:
linuxParameters
- a consumer that will call methods onLinuxParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logConfiguration
The log configuration specification for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.- Parameters:
logConfiguration
- The log configuration specification for the container.This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfiguration
default ContainerProperties.Builder logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration) The log configuration specification for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version | grep "Server API version"
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.LogConfiguration.Builder
avoiding the need to create one manually viaLogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfiguration(LogConfiguration)
.- Parameters:
logConfiguration
- a consumer that will call methods onLogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secrets
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
- Parameters:
secrets
- The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secrets
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
- Parameters:
secrets
- The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secrets
The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.
This is a convenience method that creates an instance of theSecret.Builder
avoiding the need to create one manually viaSecret.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecrets(List<Secret>)
.- Parameters:
secrets
- a consumer that will call methods onSecret.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
networkConfiguration
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
- Parameters:
networkConfiguration
- The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
default ContainerProperties.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
This is a convenience method that creates an instance of theNetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fargatePlatformConfiguration
ContainerProperties.Builder fargatePlatformConfiguration(FargatePlatformConfiguration fargatePlatformConfiguration) The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
- Parameters:
fargatePlatformConfiguration
- The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fargatePlatformConfiguration
default ContainerProperties.Builder fargatePlatformConfiguration(Consumer<FargatePlatformConfiguration.Builder> fargatePlatformConfiguration) The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
This is a convenience method that creates an instance of theFargatePlatformConfiguration.Builder
avoiding the need to create one manually viaFargatePlatformConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofargatePlatformConfiguration(FargatePlatformConfiguration)
.- Parameters:
fargatePlatformConfiguration
- a consumer that will call methods onFargatePlatformConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ephemeralStorage
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
- Parameters:
ephemeralStorage
- The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ephemeralStorage
default ContainerProperties.Builder ephemeralStorage(Consumer<EphemeralStorage.Builder> ephemeralStorage) The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
This is a convenience method that creates an instance of theEphemeralStorage.Builder
avoiding the need to create one manually viaEphemeralStorage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toephemeralStorage(EphemeralStorage)
.- Parameters:
ephemeralStorage
- a consumer that will call methods onEphemeralStorage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
runtimePlatform
An object that represents the compute environment architecture for Batch jobs on Fargate.
- Parameters:
runtimePlatform
- An object that represents the compute environment architecture for Batch jobs on Fargate.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runtimePlatform
default ContainerProperties.Builder runtimePlatform(Consumer<RuntimePlatform.Builder> runtimePlatform) An object that represents the compute environment architecture for Batch jobs on Fargate.
This is a convenience method that creates an instance of theRuntimePlatform.Builder
avoiding the need to create one manually viaRuntimePlatform.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruntimePlatform(RuntimePlatform)
.- Parameters:
runtimePlatform
- a consumer that will call methods onRuntimePlatform.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
repositoryCredentials
The private repository authentication credentials to use.
- Parameters:
repositoryCredentials
- The private repository authentication credentials to use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repositoryCredentials
default ContainerProperties.Builder repositoryCredentials(Consumer<RepositoryCredentials.Builder> repositoryCredentials) The private repository authentication credentials to use.
This is a convenience method that creates an instance of theRepositoryCredentials.Builder
avoiding the need to create one manually viaRepositoryCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torepositoryCredentials(RepositoryCredentials)
.- Parameters:
repositoryCredentials
- a consumer that will call methods onRepositoryCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-