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 the build resource that is deployed on instances in this fleet.
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) A time stamp indicating when this data object was created.
FleetAttributes.Builder	description(String description) A 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 the fleet.
FleetAttributes.Builder	fleetType(FleetType fleetType) The kind of instances, On-Demand or Spot, that this fleet uses.
FleetAttributes.Builder	fleetType(String fleetType) The kind of instances, On-Demand or Spot, that this fleet uses.
FleetAttributes.Builder	instanceRoleArn(String instanceRoleArn) A unique identifier for an IAM role that manages access to your Amazon Web Services services.
FleetAttributes.Builder	instanceType(EC2InstanceType instanceType) The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
FleetAttributes.Builder	instanceType(String instanceType) The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
FleetAttributes.Builder	logPaths(Collection<String> logPaths) This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters.
FleetAttributes.Builder	logPaths(String... logPaths) This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters.
FleetAttributes.Builder	metricGroups(Collection<String> metricGroups) Name of a metric group that metrics for this fleet are added to.
FleetAttributes.Builder	metricGroups(String... metricGroups) Name of a metric group that metrics for this fleet are added to.
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 on all new instances that are started in the fleet.
FleetAttributes.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) The type of game session protection to set on all new instances that are started in the fleet.
FleetAttributes.Builder	operatingSystem(OperatingSystem operatingSystem) The operating system of the fleet's computing resources.
FleetAttributes.Builder	operatingSystem(String operatingSystem) The operating system of the fleet's computing resources.
default FleetAttributes.Builder	resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy) The fleet policy that limits the number of game sessions an individual player can create over a span of time.
FleetAttributes.Builder	resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) The fleet policy that limits 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 the Realtime script resource that is deployed on instances in this fleet.
FleetAttributes.Builder	serverLaunchParameters(String serverLaunchParameters) This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter.
FleetAttributes.Builder	serverLaunchPath(String serverLaunchPath) This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter.
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) A list of fleet activity that has been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActions(FleetAction... stoppedActions) A list of fleet activity that has been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActionsWithStrings(Collection<String> stoppedActions) A list of fleet activity that has been suspended using StopFleetActions.
FleetAttributes.Builder	stoppedActionsWithStrings(String... stoppedActions) A list of fleet activity that has been suspended using StopFleetActions.
FleetAttributes.Builder	terminationTime(Instant terminationTime) A 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 the fleet.

Parameters:

fleetId - A unique identifier for the 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. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. 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. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. 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)

The kind of instances, On-Demand or Spot, that this fleet uses.

Parameters:

fleetType - The kind of instances, On-Demand or Spot, that this fleet uses.

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)

The kind of instances, On-Demand or Spot, that this fleet uses.

Parameters:

fleetType - The kind of instances, On-Demand or Spot, that this fleet uses.

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)

The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

Parameters:

instanceType - The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud 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)

The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

Parameters:

instanceType - The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud 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)

A human-readable description of the fleet.

Parameters:

description - A 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)

A 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 - A 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)

A 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 - A 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 -- 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 -- 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 -- 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 -- 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 the build resource that is deployed on instances in this fleet.

Parameters:

buildId - A unique identifier for the build resource that is deployed on instances in this fleet.

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 the Realtime script resource that is deployed on instances in this fleet.

Parameters:

scriptId - A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

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)

This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

Parameters:

serverLaunchPath - This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

Returns:

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

serverLaunchParameters

FleetAttributes.Builder serverLaunchParameters(String serverLaunchParameters)

This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

Parameters:

serverLaunchParameters - This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(Collection<String> logPaths)

This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(String... logPaths)

This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

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 on all new instances that are 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 on all new instances that are 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 on all new instances that are 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 on all new instances that are 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)

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

Parameters:

operatingSystem - The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script 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)

The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

Parameters:

operatingSystem - The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script 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)

The fleet policy that limits the number of game sessions an individual player can create over a span of time.

Parameters:

resourceCreationLimitPolicy - The fleet policy that limits 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)

The fleet policy that limits the number of game sessions an individual player can create over a span of time.

This is a convenience method 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)

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

Parameters:

metricGroups - Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a 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)

Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

Parameters:

metricGroups - Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a 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)

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Parameters:

stoppedActions - A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Returns:

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

stoppedActionsWithStrings

FleetAttributes.Builder stoppedActionsWithStrings(String... stoppedActions)

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Parameters:

stoppedActions - A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Returns:

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

stoppedActions

FleetAttributes.Builder stoppedActions(Collection<FleetAction> stoppedActions)

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Parameters:

stoppedActions - A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Returns:

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

stoppedActions

FleetAttributes.Builder stoppedActions(FleetAction... stoppedActions)

A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

Parameters:

stoppedActions - A list of fleet activity that has been suspended using StopFleetActions. This includes fleet 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 IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

Parameters:

instanceRoleArn - A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

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 method 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)