Package software.amazon.awscdk.services.gamelift

Class CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerGroupDefinition.ContainerDefinitionProperty>

Enclosing interface:

CfnContainerGroupDefinition.ContainerDefinitionProperty

@Stability(Stable)
public static final class CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerGroupDefinition.ContainerDefinitionProperty>

A builder for CfnContainerGroupDefinition.ContainerDefinitionProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnContainerGroupDefinition.ContainerDefinitionProperty	build()	Builds the configured instance.
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	command(List<String> command)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getCommand()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	containerName(String containerName)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getContainerName()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	cpu(Number cpu)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getCpu()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	dependsOn(List<? extends Object> dependsOn)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getDependsOn()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	dependsOn(IResolvable dependsOn)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getDependsOn()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	entryPoint(List<String> entryPoint)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEntryPoint()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	environment(List<? extends Object> environment)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEnvironment()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	environment(IResolvable environment)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEnvironment()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	essential(Boolean essential)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEssential()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	essential(IResolvable essential)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEssential()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	healthCheck(IResolvable healthCheck)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getHealthCheck()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	healthCheck(CfnContainerGroupDefinition.ContainerHealthCheckProperty healthCheck)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getHealthCheck()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	imageUri(String imageUri)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getImageUri()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	memoryLimits(IResolvable memoryLimits)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getMemoryLimits()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	memoryLimits(CfnContainerGroupDefinition.MemoryLimitsProperty memoryLimits)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getMemoryLimits()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	portConfiguration(IResolvable portConfiguration)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getPortConfiguration()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	portConfiguration(CfnContainerGroupDefinition.PortConfigurationProperty portConfiguration)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getPortConfiguration()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	resolvedImageDigest(String resolvedImageDigest)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getResolvedImageDigest()
CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder	workingDirectory(String workingDirectory)	Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getWorkingDirectory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

containerName

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder containerName(String containerName)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getContainerName()

Parameters:

containerName - The container definition identifier. This parameter is required. Container names are unique within a container group definition.

Returns:

this

imageUri

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder imageUri(String imageUri)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getImageUri()

Parameters:

imageUri - The URI to the image that $short;. This parameter is required. copied and deployed to a container fleet. For a more specific identifier, see ResolvedImageDigest .

Returns:

this

command

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder command(List<String> command)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getCommand()

Parameters:

command - A command that's passed to the container on startup. Each argument for the command is an additional string in the array. See the ContainerDefinition::command parameter in the Amazon Elastic Container Service API reference.

Returns:

this

cpu

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder cpu(Number cpu)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getCpu()

Parameters:

cpu - The number of CPU units that are reserved for the container. Note: 1 vCPU unit equals 1024 CPU units. If no resources are reserved, the container shares the total CPU limit for the container group.

Related data type: ContainerGroupDefinition$TotalCpuLimit

Returns:

this

dependsOn

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder dependsOn(IResolvable dependsOn)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getDependsOn()

Parameters:

dependsOn - Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Returns:

this

dependsOn

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder dependsOn(List<? extends Object> dependsOn)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getDependsOn()

Parameters:

dependsOn - Indicates that the container relies on the status of other containers in the same container group during its startup and shutdown sequences. A container might have dependencies on multiple containers.

Returns:

this

entryPoint

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder entryPoint(List<String> entryPoint)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEntryPoint()

Parameters:

entryPoint - The entry point that's passed to the container on startup. If there are multiple arguments, each argument is an additional string in the array. See the ContainerDefinition::entryPoint parameter in the Amazon Elastic Container Service API Reference .

Returns:

this

environment

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder environment(IResolvable environment)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEnvironment()

Parameters:

environment - A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference .

Returns:

this

environment

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder environment(List<? extends Object> environment)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEnvironment()

Parameters:

environment - A set of environment variables that's passed to the container on startup. See the ContainerDefinition::environment parameter in the Amazon Elastic Container Service API Reference .

Returns:

this

essential

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder essential(Boolean essential)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEssential()

Parameters:

essential - Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.

Returns:

this

essential

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder essential(IResolvable essential)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getEssential()

Parameters:

essential - Indicates whether the container is vital to the container group. If an essential container fails, the entire container group is restarted.

Returns:

this

healthCheck

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder healthCheck(IResolvable healthCheck)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getHealthCheck()

Parameters:

healthCheck - A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

Returns:

this

healthCheck

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder healthCheck(CfnContainerGroupDefinition.ContainerHealthCheckProperty healthCheck)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getHealthCheck()

Parameters:

healthCheck - A configuration for a non-terminal health check. A container, which automatically restarts if it stops functioning, also restarts if it fails this health check. If an essential container in the daemon group fails a health check, the entire container group is restarted. The essential container in the replica group doesn't use this health check mechanism, because the Amazon GameLift Agent automatically handles the task.

Returns:

this

memoryLimits

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder memoryLimits(IResolvable memoryLimits)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getMemoryLimits()

Parameters:

memoryLimits - The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition$TotalMemoryLimit

Returns:

this

memoryLimits

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder memoryLimits(CfnContainerGroupDefinition.MemoryLimitsProperty memoryLimits)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getMemoryLimits()

Parameters:

memoryLimits - The amount of memory that Amazon GameLift makes available to the container. If memory limits aren't set for an individual container, the container shares the container group's total memory allocation.

Related data type: ContainerGroupDefinition$TotalMemoryLimit

Returns:

this

portConfiguration

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder portConfiguration(IResolvable portConfiguration)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getPortConfiguration()

Parameters:

portConfiguration - Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. 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 .

Returns:

this

portConfiguration

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder portConfiguration(CfnContainerGroupDefinition.PortConfigurationProperty portConfiguration)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getPortConfiguration()

Parameters:

portConfiguration - Defines the ports that are available to assign to processes in the container. For example, a game server process requires a container port to allow game clients to connect to it. 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 .

Returns:

this

resolvedImageDigest

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder resolvedImageDigest(String resolvedImageDigest)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getResolvedImageDigest()

Parameters:

resolvedImageDigest - A unique and immutable identifier for the container image that is deployed to a container fleet. The digest is a SHA 256 hash of the container image manifest.

Returns:

this

workingDirectory

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty.Builder workingDirectory(String workingDirectory)

Sets the value of CfnContainerGroupDefinition.ContainerDefinitionProperty.getWorkingDirectory()

Parameters:

workingDirectory - The directory in the container where commands are run. See the ContainerDefinition::workingDirectory parameter in the Amazon Elastic Container Service API Reference .

Returns:

this

build

@Stability(Stable)
public CfnContainerGroupDefinition.ContainerDefinitionProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerGroupDefinition.ContainerDefinitionProperty>

Returns:

a new instance of CfnContainerGroupDefinition.ContainerDefinitionProperty

Throws:

NullPointerException - if any required attribute was not provided