Package software.amazon.awssdk.services.gamelift.model

Class ContainerGroupsAttributes

java.lang.Object

software.amazon.awssdk.services.gamelift.model.ContainerGroupsAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerGroupsAttributes.Builder,ContainerGroupsAttributes>

@Generated("software.amazon.awssdk:codegen")
public final class ContainerGroupsAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerGroupsAttributes.Builder,ContainerGroupsAttributes>

This data type is used with the Amazon GameLift containers feature, which is currently in public preview.

The properties of container groups that are running on a container fleet. Container group properties for a fleet can't be changed.

Returned by: DescribeFleetAttributes, CreateFleet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContainerGroupsAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static ContainerGroupsAttributes.Builder	builder()
ConnectionPortRange	connectionPortRange()	A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups.
List<ContainerGroupDefinitionProperty>	containerGroupDefinitionProperties()	A collection of properties that describe each container group in the fleet.
ContainerGroupsPerInstance	containerGroupsPerInstance()	Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainerGroupDefinitionProperties()	For responses, this returns true if the service returned a value for the ContainerGroupDefinitionProperties property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ContainerGroupsAttributes.Builder>	serializableBuilderClass()
ContainerGroupsAttributes.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasContainerGroupDefinitionProperties

public final boolean hasContainerGroupDefinitionProperties()

For responses, this returns true if the service returned a value for the ContainerGroupDefinitionProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

containerGroupDefinitionProperties

public final List<ContainerGroupDefinitionProperty> containerGroupDefinitionProperties()

A collection of properties that describe each container group in the fleet. A container fleet is deployed with one or more ContainerGroupDefinition resources, which is where these properties are set.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainerGroupDefinitionProperties() method.

Returns:

A collection of properties that describe each container group in the fleet. A container fleet is deployed with one or more ContainerGroupDefinition resources, which is where these properties are set.

connectionPortRange

public final ConnectionPortRange connectionPortRange()

A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups. Amazon GameLift maps each connection port to a container port, which is assigned to a specific container process. A fleet's connection port range can't be changed, but you can control access to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.

Returns:

A set of ports that allow inbound traffic to connect to processes running in the fleet's container groups. Amazon GameLift maps each connection port to a container port, which is assigned to a specific container process. A fleet's connection port range can't be changed, but you can control access to connection ports by updating a fleet's EC2InboundPermissions with UpdateFleetPortSettings.

containerGroupsPerInstance

public final ContainerGroupsPerInstance containerGroupsPerInstance()

Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.

Returns:

Details about the number of replica container groups that Amazon GameLift deploys to each instance in the container fleet.

toBuilder

public ContainerGroupsAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContainerGroupsAttributes.Builder,ContainerGroupsAttributes>

builder

public static ContainerGroupsAttributes.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo