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

Class FleetCapacity

java.lang.Object

software.amazon.awssdk.services.gamelift.model.FleetCapacity

All Implemented Interfaces:

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

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

Current resource capacity settings for managed EC2 fleets and container fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity, DescribeFleetLocationCapacity, UpdateFleetCapacity

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FleetCapacity.Builder

Method Summary

Modifier and Type	Method	Description
static FleetCapacity.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetArn()	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
String	fleetId()	A unique identifier for the fleet associated with the location.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EC2InstanceCounts	instanceCounts()	The current number of instances in the fleet, listed by instance status.
EC2InstanceType	instanceType()	The Amazon EC2 instance type that is used for instances in a fleet.
String	instanceTypeAsString()	The Amazon EC2 instance type that is used for instances in a fleet.
String	location()	The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as us-west-2.
ReplicaContainerGroupCounts	replicaContainerGroupCounts()	This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends FleetCapacity.Builder>	serializableBuilderClass()
FleetCapacity.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

fleetId

public final String fleetId()

A unique identifier for the fleet associated with the location.

Returns:

A unique identifier for the fleet associated with the location.

fleetArn

public final String fleetArn()

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .

Returns:

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

instanceType

public final EC2InstanceType instanceType()

The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

If the service returns an enum value that is not available in the current SDK version, instanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

See Also:

EC2InstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

If the service returns an enum value that is not available in the current SDK version, instanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

See Also:

EC2InstanceType

instanceCounts

public final EC2InstanceCounts instanceCounts()

The current number of instances in the fleet, listed by instance status. Counts for pending and terminating instances might be non-zero if the fleet is adjusting to a scaling event or if access to resources is temporarily affected.

Returns:

The current number of instances in the fleet, listed by instance status. Counts for pending and terminating instances might be non-zero if the fleet is adjusting to a scaling event or if access to resources is temporarily affected.

location

public final String location()

The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as us-west-2.

Returns:

The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as us-west-2.

replicaContainerGroupCounts

public final ReplicaContainerGroupCounts replicaContainerGroupCounts()

This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.

Returns:

This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.

toBuilder

public FleetCapacity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FleetCapacity.Builder,FleetCapacity>

builder

public static FleetCapacity.Builder builder()

serializableBuilderClass

public static Class<? extends FleetCapacity.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