com.amazonaws.services.gamelift.model

Class CreateContainerGroupDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.CreateContainerGroupDefinitionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateContainerGroupDefinitionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateContainerGroupDefinitionRequest()

Method Summary

Modifier and Type	Method and Description
CreateContainerGroupDefinitionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ContainerDefinitionInput>	getContainerDefinitions() Definitions for all containers in this group.
String	getName() A descriptive identifier for the container group definition.
String	getOperatingSystem() The platform that is used by containers in the container group definition.
String	getSchedulingStrategy() The method for deploying the container group across fleet instances.
List<Tag>	getTags() A list of labels to assign to the container group definition resource.
Integer	getTotalCpuLimit() The maximum amount of CPU units to allocate to the container group.
Integer	getTotalMemoryLimit() The maximum amount of memory (in MiB) to allocate to the container group.
int	hashCode()
void	setContainerDefinitions(Collection<ContainerDefinitionInput> containerDefinitions) Definitions for all containers in this group.
void	setName(String name) A descriptive identifier for the container group definition.
void	setOperatingSystem(String operatingSystem) The platform that is used by containers in the container group definition.
void	setSchedulingStrategy(String schedulingStrategy) The method for deploying the container group across fleet instances.
void	setTags(Collection<Tag> tags) A list of labels to assign to the container group definition resource.
void	setTotalCpuLimit(Integer totalCpuLimit) The maximum amount of CPU units to allocate to the container group.
void	setTotalMemoryLimit(Integer totalMemoryLimit) The maximum amount of memory (in MiB) to allocate to the container group.
String	toString() Returns a string representation of this object.
CreateContainerGroupDefinitionRequest	withContainerDefinitions(Collection<ContainerDefinitionInput> containerDefinitions) Definitions for all containers in this group.
CreateContainerGroupDefinitionRequest	withContainerDefinitions(ContainerDefinitionInput... containerDefinitions) Definitions for all containers in this group.
CreateContainerGroupDefinitionRequest	withName(String name) A descriptive identifier for the container group definition.
CreateContainerGroupDefinitionRequest	withOperatingSystem(ContainerOperatingSystem operatingSystem) The platform that is used by containers in the container group definition.
CreateContainerGroupDefinitionRequest	withOperatingSystem(String operatingSystem) The platform that is used by containers in the container group definition.
CreateContainerGroupDefinitionRequest	withSchedulingStrategy(ContainerSchedulingStrategy schedulingStrategy) The method for deploying the container group across fleet instances.
CreateContainerGroupDefinitionRequest	withSchedulingStrategy(String schedulingStrategy) The method for deploying the container group across fleet instances.
CreateContainerGroupDefinitionRequest	withTags(Collection<Tag> tags) A list of labels to assign to the container group definition resource.
CreateContainerGroupDefinitionRequest	withTags(Tag... tags) A list of labels to assign to the container group definition resource.
CreateContainerGroupDefinitionRequest	withTotalCpuLimit(Integer totalCpuLimit) The maximum amount of CPU units to allocate to the container group.
CreateContainerGroupDefinitionRequest	withTotalMemoryLimit(Integer totalMemoryLimit) The maximum amount of memory (in MiB) to allocate to the container group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateContainerGroupDefinitionRequest

public CreateContainerGroupDefinitionRequest()

Method Detail

setName

public void setName(String name)

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

Parameters:

name - A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

getName

public String getName()

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

Returns:

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

withName

public CreateContainerGroupDefinitionRequest withName(String name)

A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

Parameters:

name - A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSchedulingStrategy

public void setSchedulingStrategy(String schedulingStrategy)

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Parameters:

schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

See Also:

ContainerSchedulingStrategy

getSchedulingStrategy

public String getSchedulingStrategy()

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Returns:

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

See Also:

ContainerSchedulingStrategy

withSchedulingStrategy

public CreateContainerGroupDefinitionRequest withSchedulingStrategy(String schedulingStrategy)

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Parameters:

schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerSchedulingStrategy

withSchedulingStrategy

public CreateContainerGroupDefinitionRequest withSchedulingStrategy(ContainerSchedulingStrategy schedulingStrategy)

The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Parameters:

schedulingStrategy - The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group has one copy per fleet instance. Default value is REPLICA.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerSchedulingStrategy

setTotalMemoryLimit

public void setTotalMemoryLimit(Integer totalMemoryLimit)

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Parameters:

totalMemoryLimit - The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

getTotalMemoryLimit

public Integer getTotalMemoryLimit()

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Returns:

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

withTotalMemoryLimit

public CreateContainerGroupDefinitionRequest withTotalMemoryLimit(Integer totalMemoryLimit)

The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Parameters:

totalMemoryLimit - The maximum amount of memory (in MiB) to allocate to the container group. All containers in the group share this memory. If you specify memory limits for individual containers, set this parameter based on the following guidelines. The value must be (1) greater than the sum of the soft memory limits for all containers in the group, and (2) greater than any individual container's hard memory limit.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTotalCpuLimit

public void setTotalCpuLimit(Integer totalCpuLimit)

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Parameters:

totalCpuLimit - The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

getTotalCpuLimit

public Integer getTotalCpuLimit()

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Returns:

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

withTotalCpuLimit

public CreateContainerGroupDefinitionRequest withTotalCpuLimit(Integer totalCpuLimit)

The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Parameters:

totalCpuLimit - The maximum amount of CPU units to allocate to the container group. Set this parameter to an integer value in CPU units (1 vCPU is equal to 1024 CPU units). All containers in the group share this memory. If you specify CPU limits for individual containers, set this parameter based on the following guidelines. The value must be equal to or greater than the sum of the CPU limits for all containers in the group.

Returns:

Returns a reference to this object so that method calls can be chained together.

getContainerDefinitions

public List<ContainerDefinitionInput> getContainerDefinitions()

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Returns:

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

setContainerDefinitions

public void setContainerDefinitions(Collection<ContainerDefinitionInput> containerDefinitions)

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Parameters:

containerDefinitions - Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

withContainerDefinitions

public CreateContainerGroupDefinitionRequest withContainerDefinitions(ContainerDefinitionInput... containerDefinitions)

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

NOTE: This method appends the values to the existing list (if any). Use setContainerDefinitions(java.util.Collection) or withContainerDefinitions(java.util.Collection) if you want to override the existing values.

Parameters:

containerDefinitions - Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Returns:

Returns a reference to this object so that method calls can be chained together.

withContainerDefinitions

public CreateContainerGroupDefinitionRequest withContainerDefinitions(Collection<ContainerDefinitionInput> containerDefinitions)

Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Parameters:

containerDefinitions - Definitions for all containers in this group. Each container definition identifies the container image and specifies configuration settings for the container. See the Container fleet design guide for container guidelines.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperatingSystem

public void setOperatingSystem(String operatingSystem)

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Parameters:

operatingSystem - The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

See Also:

ContainerOperatingSystem

getOperatingSystem

public String getOperatingSystem()

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Returns:

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

See Also:

ContainerOperatingSystem

withOperatingSystem

public CreateContainerGroupDefinitionRequest withOperatingSystem(String operatingSystem)

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Parameters:

operatingSystem - The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerOperatingSystem

withOperatingSystem

public CreateContainerGroupDefinitionRequest withOperatingSystem(ContainerOperatingSystem operatingSystem)

The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Parameters:

operatingSystem - The platform that is used by containers in the container group definition. All containers in a group must run on the same operating system.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerOperatingSystem

getTags

public List<Tag> getTags()

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

setTags

public void setTags(Collection<Tag> tags)

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

withTags

public CreateContainerGroupDefinitionRequest withTags(Tag... tags)

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateContainerGroupDefinitionRequest withTags(Collection<Tag> tags)

A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - A list of labels to assign to the container group definition resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateContainerGroupDefinitionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()