@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ContainerDefinitionInput extends Object implements Serializable, Cloneable, StructuredPojo
This data type is used with the Amazon GameLift containers feature, which is currently in public preview.
Describes a container's configuration, resources, and start instructions. Use this data type to create a container group definition. For the properties of a container that's been deployed to a fleet, see ContainerDefinition. You can't change these properties after you've created the container group definition. If you need a container group with different properties, then you must create a new one.
Used with: CreateContainerGroupDefinition
Constructor and Description |
---|
ContainerDefinitionInput() |
Modifier and Type | Method and Description |
---|---|
ContainerDefinitionInput |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCommand()
A command to pass to the container on startup.
|
String |
getContainerName()
A string that uniquely identifies the container definition within a container group.
|
Integer |
getCpu()
The number of CPU units to reserve for this container.
|
List<ContainerDependency> |
getDependsOn()
Sets up dependencies between this container and the status of other containers in the same container group.
|
List<String> |
getEntryPoint()
An entry point to pass to the container on startup.
|
List<ContainerEnvironment> |
getEnvironment()
A set of environment variables to pass to the container on startup.
|
Boolean |
getEssential()
Specifies whether the container is vital for the container group to function properly.
|
ContainerHealthCheck |
getHealthCheck()
Configuration for a non-terminal health check.
|
String |
getImageUri()
The location of a container image that $short; will copy and deploy to a container fleet.
|
ContainerMemoryLimits |
getMemoryLimits()
The amount of memory to make available to the container.
|
ContainerPortConfiguration |
getPortConfiguration()
A set of ports that Amazon GameLift can assign to processes in the container.
|
String |
getWorkingDirectory()
The directory in the container where commands are run.
|
int |
hashCode() |
Boolean |
isEssential()
Specifies whether the container is vital for the container group to function properly.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCommand(Collection<String> command)
A command to pass to the container on startup.
|
void |
setContainerName(String containerName)
A string that uniquely identifies the container definition within a container group.
|
void |
setCpu(Integer cpu)
The number of CPU units to reserve for this container.
|
void |
setDependsOn(Collection<ContainerDependency> dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group.
|
void |
setEntryPoint(Collection<String> entryPoint)
An entry point to pass to the container on startup.
|
void |
setEnvironment(Collection<ContainerEnvironment> environment)
A set of environment variables to pass to the container on startup.
|
void |
setEssential(Boolean essential)
Specifies whether the container is vital for the container group to function properly.
|
void |
setHealthCheck(ContainerHealthCheck healthCheck)
Configuration for a non-terminal health check.
|
void |
setImageUri(String imageUri)
The location of a container image that $short; will copy and deploy to a container fleet.
|
void |
setMemoryLimits(ContainerMemoryLimits memoryLimits)
The amount of memory to make available to the container.
|
void |
setPortConfiguration(ContainerPortConfiguration portConfiguration)
A set of ports that Amazon GameLift can assign to processes in the container.
|
void |
setWorkingDirectory(String workingDirectory)
The directory in the container where commands are run.
|
String |
toString()
Returns a string representation of this object.
|
ContainerDefinitionInput |
withCommand(Collection<String> command)
A command to pass to the container on startup.
|
ContainerDefinitionInput |
withCommand(String... command)
A command to pass to the container on startup.
|
ContainerDefinitionInput |
withContainerName(String containerName)
A string that uniquely identifies the container definition within a container group.
|
ContainerDefinitionInput |
withCpu(Integer cpu)
The number of CPU units to reserve for this container.
|
ContainerDefinitionInput |
withDependsOn(Collection<ContainerDependency> dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group.
|
ContainerDefinitionInput |
withDependsOn(ContainerDependency... dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group.
|
ContainerDefinitionInput |
withEntryPoint(Collection<String> entryPoint)
An entry point to pass to the container on startup.
|
ContainerDefinitionInput |
withEntryPoint(String... entryPoint)
An entry point to pass to the container on startup.
|
ContainerDefinitionInput |
withEnvironment(Collection<ContainerEnvironment> environment)
A set of environment variables to pass to the container on startup.
|
ContainerDefinitionInput |
withEnvironment(ContainerEnvironment... environment)
A set of environment variables to pass to the container on startup.
|
ContainerDefinitionInput |
withEssential(Boolean essential)
Specifies whether the container is vital for the container group to function properly.
|
ContainerDefinitionInput |
withHealthCheck(ContainerHealthCheck healthCheck)
Configuration for a non-terminal health check.
|
ContainerDefinitionInput |
withImageUri(String imageUri)
The location of a container image that $short; will copy and deploy to a container fleet.
|
ContainerDefinitionInput |
withMemoryLimits(ContainerMemoryLimits memoryLimits)
The amount of memory to make available to the container.
|
ContainerDefinitionInput |
withPortConfiguration(ContainerPortConfiguration portConfiguration)
A set of ports that Amazon GameLift can assign to processes in the container.
|
ContainerDefinitionInput |
withWorkingDirectory(String workingDirectory)
The directory in the container where commands are run.
|
public void setContainerName(String containerName)
A string that uniquely identifies the container definition within a container group.
containerName
- A string that uniquely identifies the container definition within a container group.public String getContainerName()
A string that uniquely identifies the container definition within a container group.
public ContainerDefinitionInput withContainerName(String containerName)
A string that uniquely identifies the container definition within a container group.
containerName
- A string that uniquely identifies the container definition within a container group.public void setImageUri(String imageUri)
The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
imageUri
- The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon
Elastic Container Registry private repositories are supported. The repository must be in the same Amazon
Web Services account and Amazon Web Services Region where you're creating the container group definition.
For limits on image size, see Amazon
GameLift endpoints and quotas. You can use any of the following image URI formats:
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
public String getImageUri()
The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
public ContainerDefinitionInput withImageUri(String imageUri)
The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon Elastic Container Registry private repositories are supported. The repository must be in the same Amazon Web Services account and Amazon Web Services Region where you're creating the container group definition. For limits on image size, see Amazon GameLift endpoints and quotas. You can use any of the following image URI formats:
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
imageUri
- The location of a container image that $short; will copy and deploy to a container fleet. Images in Amazon
Elastic Container Registry private repositories are supported. The repository must be in the same Amazon
Web Services account and Amazon Web Services Region where you're creating the container group definition.
For limits on image size, see Amazon
GameLift endpoints and quotas. You can use any of the following image URI formats:
Image ID only: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]
Image ID and digest:
[AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]@[digest]
Image ID and tag: [AWS account].dkr.ecr.[AWS region].amazonaws.com/[repository ID]:[tag]
public void setMemoryLimits(ContainerMemoryLimits memoryLimits)
The amount of memory to make available to the container. If you don't specify memory limits for this container, then it shares the container group's total memory allocation.
Related data type: ContainerGroupDefinition$TotalMemoryLimit
memoryLimits
- The amount of memory to make available to the container. If you don't specify memory limits for this
container, then it shares the container group's total memory allocation.
Related data type: ContainerGroupDefinition$TotalMemoryLimit
public ContainerMemoryLimits getMemoryLimits()
The amount of memory to make available to the container. If you don't specify memory limits for this container, then it shares the container group's total memory allocation.
Related data type: ContainerGroupDefinition$TotalMemoryLimit
Related data type: ContainerGroupDefinition$TotalMemoryLimit
public ContainerDefinitionInput withMemoryLimits(ContainerMemoryLimits memoryLimits)
The amount of memory to make available to the container. If you don't specify memory limits for this container, then it shares the container group's total memory allocation.
Related data type: ContainerGroupDefinition$TotalMemoryLimit
memoryLimits
- The amount of memory to make available to the container. If you don't specify memory limits for this
container, then it shares the container group's total memory allocation.
Related data type: ContainerGroupDefinition$TotalMemoryLimit
public void setPortConfiguration(ContainerPortConfiguration portConfiguration)
A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept inbound traffic connections, including game server processes, must be assigned a port from this set. The set of ports must be large enough to assign one to each process in the container that needs one. If the container includes your game server, include enough ports to assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container fleets.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to
externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
portConfiguration
- A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept
inbound traffic connections, including game server processes, must be assigned a port from this set. The
set of ports must be large enough to assign one to each process in the container that needs one. If the
container includes your game server, include enough ports to assign one port to each concurrent server
process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for
container fleets.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to
externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
public ContainerPortConfiguration getPortConfiguration()
A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept inbound traffic connections, including game server processes, must be assigned a port from this set. The set of ports must be large enough to assign one to each process in the container that needs one. If the container includes your game server, include enough ports to assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container fleets.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to
externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports
to externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
public ContainerDefinitionInput withPortConfiguration(ContainerPortConfiguration portConfiguration)
A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept inbound traffic connections, including game server processes, must be assigned a port from this set. The set of ports must be large enough to assign one to each process in the container that needs one. If the container includes your game server, include enough ports to assign one port to each concurrent server process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for container fleets.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to
externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
portConfiguration
- A set of ports that Amazon GameLift can assign to processes in the container. All processes that accept
inbound traffic connections, including game server processes, must be assigned a port from this set. The
set of ports must be large enough to assign one to each process in the container that needs one. If the
container includes your game server, include enough ports to assign one port to each concurrent server
process (as defined in a container fleet's RuntimeConfiguration). For more details, see Networking for
container fleets.
Container ports aren't directly accessed by inbound traffic. Amazon GameLift maps these container ports to
externally accessible connection ports, which are assigned as needed from the container fleet's
ConnectionPortRange
.
public void setCpu(Integer cpu)
The number of CPU units to reserve for this container. The container can use more resources when needed, if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container, then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS container definition parameter environment (Amazon Elastic Container Service Developer Guide).
Related data type: ContainerGroupDefinition$TotalCpuLimit
cpu
- The number of CPU units to reserve for this container. The container can use more resources when needed,
if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container,
then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS
container definition parameter environment (Amazon Elastic Container Service Developer Guide).
Related data type: ContainerGroupDefinition$TotalCpuLimit
public Integer getCpu()
The number of CPU units to reserve for this container. The container can use more resources when needed, if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container, then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS container definition parameter environment (Amazon Elastic Container Service Developer Guide).
Related data type: ContainerGroupDefinition$TotalCpuLimit
Related data type: ContainerGroupDefinition$TotalCpuLimit
public ContainerDefinitionInput withCpu(Integer cpu)
The number of CPU units to reserve for this container. The container can use more resources when needed, if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container, then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS container definition parameter environment (Amazon Elastic Container Service Developer Guide).
Related data type: ContainerGroupDefinition$TotalCpuLimit
cpu
- The number of CPU units to reserve for this container. The container can use more resources when needed,
if available. Note: 1 vCPU unit equals 1024 CPU units. If you don't reserve CPU units for this container,
then it shares the total CPU limit for the container group. This property is similar to the Amazon ECS
container definition parameter environment (Amazon Elastic Container Service Developer Guide).
Related data type: ContainerGroupDefinition$TotalCpuLimit
public void setHealthCheck(ContainerHealthCheck healthCheck)
Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. This parameter lets you define additional reasons to consider a container unhealthy and restart it. You can set a health check for any container except for the essential container in the replica container group. If an essential container in the daemon group fails a health check, the entire container group is restarted.
healthCheck
- Configuration for a non-terminal health check. A container automatically restarts if it stops functioning.
This parameter lets you define additional reasons to consider a container unhealthy and restart it. You
can set a health check for any container except for the essential container in the replica container
group. If an essential container in the daemon group fails a health check, the entire container group is
restarted.public ContainerHealthCheck getHealthCheck()
Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. This parameter lets you define additional reasons to consider a container unhealthy and restart it. You can set a health check for any container except for the essential container in the replica container group. If an essential container in the daemon group fails a health check, the entire container group is restarted.
public ContainerDefinitionInput withHealthCheck(ContainerHealthCheck healthCheck)
Configuration for a non-terminal health check. A container automatically restarts if it stops functioning. This parameter lets you define additional reasons to consider a container unhealthy and restart it. You can set a health check for any container except for the essential container in the replica container group. If an essential container in the daemon group fails a health check, the entire container group is restarted.
healthCheck
- Configuration for a non-terminal health check. A container automatically restarts if it stops functioning.
This parameter lets you define additional reasons to consider a container unhealthy and restart it. You
can set a health check for any container except for the essential container in the replica container
group. If an essential container in the daemon group fails a health check, the entire container group is
restarted.public List<String> getCommand()
A command to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.
public void setCommand(Collection<String> command)
A command to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.
command
- A command to pass to the container on startup. Add multiple arguments as additional strings in the array.
See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.public ContainerDefinitionInput withCommand(String... command)
A command to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.
NOTE: This method appends the values to the existing list (if any). Use
setCommand(java.util.Collection)
or withCommand(java.util.Collection)
if you want to override
the existing values.
command
- A command to pass to the container on startup. Add multiple arguments as additional strings in the array.
See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.public ContainerDefinitionInput withCommand(Collection<String> command)
A command to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.
command
- A command to pass to the container on startup. Add multiple arguments as additional strings in the array.
See the ContainerDefinition command parameter in the Amazon Elastic Container Service API reference.public void setEssential(Boolean essential)
Specifies whether the container is vital for the container group to function properly. If an essential container fails, it causes the entire container group to restart. Each container group must have an essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
essential
- Specifies whether the container is vital for the container group to function properly. If an essential
container fails, it causes the entire container group to restart. Each container group must have an
essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
public Boolean getEssential()
Specifies whether the container is vital for the container group to function properly. If an essential container fails, it causes the entire container group to restart. Each container group must have an essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
public ContainerDefinitionInput withEssential(Boolean essential)
Specifies whether the container is vital for the container group to function properly. If an essential container fails, it causes the entire container group to restart. Each container group must have an essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
essential
- Specifies whether the container is vital for the container group to function properly. If an essential
container fails, it causes the entire container group to restart. Each container group must have an
essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
public Boolean isEssential()
Specifies whether the container is vital for the container group to function properly. If an essential container fails, it causes the entire container group to restart. Each container group must have an essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
Replica container groups - A replica group must have exactly one essential container. Use the following to configure an essential replica container:
Choose a container is running your game server and the Amazon GameLift Agent.
Include a port configuration. This container runs your game server processes, and each process requires a container port to allow access to game clients.
Don't configure a health check. The Agent handles this task for the essential replica container.
Daemon container groups - A daemon group must have at least one essential container.
public List<String> getEntryPoint()
An entry point to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
public void setEntryPoint(Collection<String> entryPoint)
An entry point to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
entryPoint
- An entry point to pass to the container on startup. Add multiple arguments as additional strings in the
array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API
Reference.public ContainerDefinitionInput withEntryPoint(String... entryPoint)
An entry point to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
NOTE: This method appends the values to the existing list (if any). Use
setEntryPoint(java.util.Collection)
or withEntryPoint(java.util.Collection)
if you want to
override the existing values.
entryPoint
- An entry point to pass to the container on startup. Add multiple arguments as additional strings in the
array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API
Reference.public ContainerDefinitionInput withEntryPoint(Collection<String> entryPoint)
An entry point to pass to the container on startup. Add multiple arguments as additional strings in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference.
entryPoint
- An entry point to pass to the container on startup. Add multiple arguments as additional strings in the
array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API
Reference.public void setWorkingDirectory(String workingDirectory)
The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.
workingDirectory
- The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API
Reference.public String getWorkingDirectory()
The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.
public ContainerDefinitionInput withWorkingDirectory(String workingDirectory)
The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference.
workingDirectory
- The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API
Reference.public List<ContainerEnvironment> getEnvironment()
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
public void setEnvironment(Collection<ContainerEnvironment> environment)
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
environment
- A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API
Reference.public ContainerDefinitionInput withEnvironment(ContainerEnvironment... environment)
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironment(java.util.Collection)
or withEnvironment(java.util.Collection)
if you want to
override the existing values.
environment
- A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API
Reference.public ContainerDefinitionInput withEnvironment(Collection<ContainerEnvironment> environment)
A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference.
environment
- A set of environment variables to pass to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API
Reference.public List<ContainerDependency> getDependsOn()
Sets up dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on SideCarContainerA.
This dependency means that SideCarContainerB can't start until after SideCarContainerA has started. This
dependency is reversed on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA
can shut down.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on
SideCarContainerA. This dependency means that SideCarContainerB can't start until after SideCarContainerA
has started. This dependency is reversed on shutdown, which means that SideCarContainerB must shut down
before SideCarContainerA can shut down.
public void setDependsOn(Collection<ContainerDependency> dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on SideCarContainerA.
This dependency means that SideCarContainerB can't start until after SideCarContainerA has started. This
dependency is reversed on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA
can shut down.
dependsOn
- Sets up dependencies between this container and the status of other containers in the same container
group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on
SideCarContainerA. This dependency means that SideCarContainerB can't start until after SideCarContainerA
has started. This dependency is reversed on shutdown, which means that SideCarContainerB must shut down
before SideCarContainerA can shut down.
public ContainerDefinitionInput withDependsOn(ContainerDependency... dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on SideCarContainerA.
This dependency means that SideCarContainerB can't start until after SideCarContainerA has started. This
dependency is reversed on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA
can shut down.
NOTE: This method appends the values to the existing list (if any). Use
setDependsOn(java.util.Collection)
or withDependsOn(java.util.Collection)
if you want to
override the existing values.
dependsOn
- Sets up dependencies between this container and the status of other containers in the same container
group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on
SideCarContainerA. This dependency means that SideCarContainerB can't start until after SideCarContainerA
has started. This dependency is reversed on shutdown, which means that SideCarContainerB must shut down
before SideCarContainerA can shut down.
public ContainerDefinitionInput withDependsOn(Collection<ContainerDependency> dependsOn)
Sets up dependencies between this container and the status of other containers in the same container group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on SideCarContainerA.
This dependency means that SideCarContainerB can't start until after SideCarContainerA has started. This
dependency is reversed on shutdown, which means that SideCarContainerB must shut down before SideCarContainerA
can shut down.
dependsOn
- Sets up dependencies between this container and the status of other containers in the same container
group. A container can have dependencies on multiple different containers.
You can use dependencies to establish a startup/shutdown sequence across the container group. A container startup dependency is reversed on shutdown.
For example, you might specify that SideCarContainerB has a START
dependency on
SideCarContainerA. This dependency means that SideCarContainerB can't start until after SideCarContainerA
has started. This dependency is reversed on shutdown, which means that SideCarContainerB must shut down
before SideCarContainerA can shut down.
public String toString()
toString
in class Object
Object.toString()
public ContainerDefinitionInput clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.