software.amazon.awssdk.services.gamelift.model

Interface FleetAttributes.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FleetAttributes.Builder,FleetAttributes>, SdkBuilder<FleetAttributes.Builder,FleetAttributes>, SdkPojo

Enclosing class:

FleetAttributes

public static interface FleetAttributes.Builder
extends SdkPojo, CopyableBuilder<FleetAttributes.Builder,FleetAttributes>

Method Summary

Modifier and Type	Method and Description
FleetAttributes.Builder	buildArn(String buildArn) The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet.
FleetAttributes.Builder	buildId(String buildId) A unique identifier for a build.
FleetAttributes.Builder	certificateConfiguration(CertificateConfiguration certificateConfiguration) Indicates whether a TLS/SSL certificate was generated for the fleet.
default FleetAttributes.Builder	certificateConfiguration(Consumer<CertificateConfiguration.Builder> certificateConfiguration) Indicates whether a TLS/SSL certificate was generated for the fleet.
FleetAttributes.Builder	creationTime(Instant creationTime) Time stamp indicating when this data object was created.
FleetAttributes.Builder	description(String description) Human-readable description of the fleet.
FleetAttributes.Builder	fleetArn(String fleetArn) The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it.
FleetAttributes.Builder	fleetId(String fleetId) A unique identifier for a fleet.
FleetAttributes.Builder	fleetType(FleetType fleetType) Indicates whether the fleet uses on-demand or spot instances.
FleetAttributes.Builder	fleetType(String fleetType) Indicates whether the fleet uses on-demand or spot instances.
FleetAttributes.Builder	instanceRoleArn(String instanceRoleArn) A unique identifier for an AWS IAM role that manages access to your AWS services.
FleetAttributes.Builder	instanceType(EC2InstanceType instanceType) EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
FleetAttributes.Builder	instanceType(String instanceType) EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
FleetAttributes.Builder	logPaths(Collection<String> logPaths) Location of default log files.
FleetAttributes.Builder	logPaths(String... logPaths) Location of default log files.
FleetAttributes.Builder	metricGroups(Collection<String> metricGroups) Names of metric groups that this fleet is included in.
FleetAttributes.Builder	metricGroups(String... metricGroups) Names of metric groups that this fleet is included in.
FleetAttributes.Builder	name(String name) A descriptive label that is associated with a fleet.
FleetAttributes.Builder	newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) The type of game session protection to set for all new instances started in the fleet.
FleetAttributes.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) The type of game session protection to set for all new instances started in the fleet.
FleetAttributes.Builder	operatingSystem(OperatingSystem operatingSystem) Operating system of the fleet's computing resources.
FleetAttributes.Builder	operatingSystem(String operatingSystem) Operating system of the fleet's computing resources.
default FleetAttributes.Builder	resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy) Fleet policy to limit the number of game sessions an individual player can create over a span of time.
FleetAttributes.Builder	resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) Fleet policy to limit the number of game sessions an individual player can create over a span of time.
FleetAttributes.Builder	scriptArn(String scriptArn) The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet.
FleetAttributes.Builder	scriptId(String scriptId) A unique identifier for a Realtime script.
FleetAttributes.Builder	serverLaunchParameters(String serverLaunchParameters) Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v.
FleetAttributes.Builder	serverLaunchPath(String serverLaunchPath) Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v.
FleetAttributes.Builder	status(FleetStatus status) Current status of the fleet.
FleetAttributes.Builder	status(String status) Current status of the fleet.
FleetAttributes.Builder	stoppedActions(Collection<FleetAction> stoppedActions) List of fleet activity that have been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActions(FleetAction... stoppedActions) List of fleet activity that have been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActionsWithStrings(Collection<String> stoppedActions) List of fleet activity that have been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActionsWithStrings(String... stoppedActions) List of fleet activity that have been suspended using StopFleetActions.
FleetAttributes.Builder	terminationTime(Instant terminationTime) Time stamp indicating when this data object was terminated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

fleetId

FleetAttributes.Builder fleetId(String fleetId)

A unique identifier for a fleet.

Parameters:

fleetId - A unique identifier for a fleet.

Returns:

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

fleetArn

FleetAttributes.Builder fleetArn(String fleetArn)

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Parameters:

fleetArn - The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Returns:

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

fleetType

FleetAttributes.Builder fleetType(String fleetType)

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Parameters:

fleetType - Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Returns:

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

See Also:

FleetType, FleetType

fleetType

FleetAttributes.Builder fleetType(FleetType fleetType)

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Parameters:

fleetType - Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

Returns:

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

See Also:

FleetType, FleetType

instanceType

FleetAttributes.Builder instanceType(String instanceType)

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

instanceType - EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType, EC2InstanceType

instanceType

FleetAttributes.Builder instanceType(EC2InstanceType instanceType)

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

instanceType - EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType, EC2InstanceType

description

FleetAttributes.Builder description(String description)

Human-readable description of the fleet.

Parameters:

description - Human-readable description of the fleet.

Returns:

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

name

FleetAttributes.Builder name(String name)

A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Parameters:

name - A descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

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

creationTime

FleetAttributes.Builder creationTime(Instant creationTime)

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

terminationTime

FleetAttributes.Builder terminationTime(Instant terminationTime)

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

terminationTime - Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

status

FleetAttributes.Builder status(String status)

Current status of the fleet.

Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

Parameters:

status - Current status of the fleet.

Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

Returns:

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

See Also:

FleetStatus, FleetStatus

status

FleetAttributes.Builder status(FleetStatus status)

Current status of the fleet.

Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

Parameters:

status - Current status of the fleet.

Possible fleet statuses include the following:

• NEW -- A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

• ACTIVE -- Hosts can now accept game sessions.

• ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

• DELETING -- Hosts are responding to a delete fleet request.

• TERMINATED -- The fleet no longer exists.

Returns:

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

See Also:

FleetStatus, FleetStatus

buildId

FleetAttributes.Builder buildId(String buildId)

A unique identifier for a build.

Parameters:

buildId - A unique identifier for a build.

Returns:

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

buildArn

FleetAttributes.Builder buildArn(String buildArn)

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Parameters:

buildArn - The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Returns:

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

scriptId

FleetAttributes.Builder scriptId(String scriptId)

A unique identifier for a Realtime script.

Parameters:

scriptId - A unique identifier for a Realtime script.

Returns:

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

scriptArn

FleetAttributes.Builder scriptArn(String scriptArn)

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Parameters:

scriptArn - The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Returns:

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

serverLaunchPath

FleetAttributes.Builder serverLaunchPath(String serverLaunchPath)

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Parameters:

serverLaunchPath - Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Returns:

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

serverLaunchParameters

FleetAttributes.Builder serverLaunchParameters(String serverLaunchParameters)

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Parameters:

serverLaunchParameters - Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(Collection<String> logPaths)

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Parameters:

logPaths - Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(String... logPaths)

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Parameters:

logPaths - Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Returns:

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

newGameSessionProtectionPolicy

FleetAttributes.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

The type of game session protection to set for all new instances started in the fleet.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - The type of game session protection to set for all new instances started in the fleet.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy, ProtectionPolicy

newGameSessionProtectionPolicy

FleetAttributes.Builder newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

The type of game session protection to set for all new instances started in the fleet.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - The type of game session protection to set for all new instances started in the fleet.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy, ProtectionPolicy

operatingSystem

FleetAttributes.Builder operatingSystem(String operatingSystem)

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Parameters:

operatingSystem - Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Returns:

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

See Also:

OperatingSystem, OperatingSystem

operatingSystem

FleetAttributes.Builder operatingSystem(OperatingSystem operatingSystem)

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Parameters:

operatingSystem - Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Returns:

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

See Also:

OperatingSystem, OperatingSystem

resourceCreationLimitPolicy

FleetAttributes.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Parameters:

resourceCreationLimitPolicy - Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Returns:

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

resourceCreationLimitPolicy

default FleetAttributes.Builder resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy)

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

This is a convenience that creates an instance of the ResourceCreationLimitPolicy.Builder avoiding the need to create one manually via ResourceCreationLimitPolicy.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceCreationLimitPolicy(ResourceCreationLimitPolicy).

Parameters:

resourceCreationLimitPolicy - a consumer that will call methods on ResourceCreationLimitPolicy.Builder

Returns:

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

See Also:

resourceCreationLimitPolicy(ResourceCreationLimitPolicy)

metricGroups

FleetAttributes.Builder metricGroups(Collection<String> metricGroups)

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Parameters:

metricGroups - Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Returns:

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

metricGroups

FleetAttributes.Builder metricGroups(String... metricGroups)

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Parameters:

metricGroups - Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

Returns:

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

stoppedActionsWithStrings

FleetAttributes.Builder stoppedActionsWithStrings(Collection<String> stoppedActions)

List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Parameters:

stoppedActions - List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Returns:

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

stoppedActionsWithStrings

FleetAttributes.Builder stoppedActionsWithStrings(String... stoppedActions)

List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Parameters:

stoppedActions - List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Returns:

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

stoppedActions

FleetAttributes.Builder stoppedActions(Collection<FleetAction> stoppedActions)

List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Parameters:

stoppedActions - List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Returns:

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

stoppedActions

FleetAttributes.Builder stoppedActions(FleetAction... stoppedActions)

List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Parameters:

stoppedActions - List of fleet activity that have been suspended using StopFleetActions. This includes auto-scaling.

Returns:

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

instanceRoleArn

FleetAttributes.Builder instanceRoleArn(String instanceRoleArn)

A unique identifier for an AWS IAM role that manages access to your AWS services.

Parameters:

instanceRoleArn - A unique identifier for an AWS IAM role that manages access to your AWS services.

Returns:

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

certificateConfiguration

FleetAttributes.Builder certificateConfiguration(CertificateConfiguration certificateConfiguration)

Indicates whether a TLS/SSL certificate was generated for the fleet.

Parameters:

certificateConfiguration - Indicates whether a TLS/SSL certificate was generated for the fleet.

Returns:

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

certificateConfiguration

default FleetAttributes.Builder certificateConfiguration(Consumer<CertificateConfiguration.Builder> certificateConfiguration)

Indicates whether a TLS/SSL certificate was generated for the fleet.

This is a convenience that creates an instance of the CertificateConfiguration.Builder avoiding the need to create one manually via CertificateConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to certificateConfiguration(CertificateConfiguration).

Parameters:

certificateConfiguration - a consumer that will call methods on CertificateConfiguration.Builder

Returns:

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

See Also:

certificateConfiguration(CertificateConfiguration)