public static interface FleetAttributes.Builder extends SdkPojo, CopyableBuilder<FleetAttributes.Builder,FleetAttributes>
| Modifier and Type | Method and Description |
|---|---|
FleetAttributes.Builder |
anywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
Sets the value of the AnywhereConfiguration property for this object.
|
default FleetAttributes.Builder |
anywhereConfiguration(Consumer<AnywhereConfiguration.Builder> anywhereConfiguration)
Sets the value of the AnywhereConfiguration property for this object.
|
FleetAttributes.Builder |
buildArn(String buildArn)
The Amazon Resource Name (ARN) associated with the Amazon
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)
Sets the value of the CertificateConfiguration property for this object.
|
default FleetAttributes.Builder |
certificateConfiguration(Consumer<CertificateConfiguration.Builder> certificateConfiguration)
Sets the value of the CertificateConfiguration property for this object.
|
FleetAttributes.Builder |
computeType(ComputeType computeType)
The type of compute resource used to host your game servers.
|
FleetAttributes.Builder |
computeType(String computeType)
The type of compute resource used to host your game servers.
|
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
Amazon GameLift fleet resource and uniquely identifies it.
|
FleetAttributes.Builder |
fleetId(String fleetId)
A unique identifier for the fleet.
|
FleetAttributes.Builder |
fleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
FleetAttributes.Builder |
fleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
FleetAttributes.Builder |
instanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role with access permissions to other Amazon Web Services services.
|
FleetAttributes.Builder |
instanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. |
FleetAttributes.Builder |
instanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. |
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 Amazon 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 Amazon 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)
Sets the value of the ResourceCreationLimitPolicy property for this object.
|
FleetAttributes.Builder |
resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Sets the value of the ResourceCreationLimitPolicy property for this object.
|
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 runtime
configuration .
|
FleetAttributes.Builder |
serverLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .
|
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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildFleetAttributes.Builder fleetId(String fleetId)
A unique identifier for the fleet.
fleetId - A unique identifier for the fleet.FleetAttributes.Builder fleetArn(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. In a GameLift
fleet ARN, the resource ID matches the FleetId value.
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. In a
GameLift fleet ARN, the resource ID matches the FleetId value.FleetAttributes.Builder fleetType(String fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
fleetType - Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set
to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is
created.FleetType,
FleetTypeFleetAttributes.Builder fleetType(FleetType fleetType)
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
fleetType - Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set
to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is
created.FleetType,
FleetTypeFleetAttributes.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.
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.EC2InstanceType,
EC2InstanceTypeFleetAttributes.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.
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.EC2InstanceType,
EC2InstanceTypeFleetAttributes.Builder description(String description)
A human-readable description of the fleet.
description - A human-readable description of the fleet.FleetAttributes.Builder name(String name)
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
name - A descriptive label that is associated with a fleet. Fleet names do not need to be unique.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").
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").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").
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").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.
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.
FleetStatus,
FleetStatusFleetAttributes.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.
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.
FleetStatus,
FleetStatusFleetAttributes.Builder buildId(String buildId)
A unique identifier for the build resource that is deployed on instances in this fleet.
buildId - A unique identifier for the build resource that is deployed on instances in this fleet.FleetAttributes.Builder buildArn(String buildArn)
The Amazon Resource Name (ARN) associated with the Amazon
GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID
matches the BuildId value.
buildArn - The Amazon Resource Name (ARN) associated with the
Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN,
the resource ID matches the BuildId value.FleetAttributes.Builder scriptId(String scriptId)
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
scriptId - A unique identifier for the Realtime script resource that is deployed on instances in this fleet.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.
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.FleetAttributes.Builder serverLaunchPath(String serverLaunchPath)
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
serverLaunchPath - This parameter is no longer used. Server launch paths are now defined using the fleet's
RuntimeConfiguration . Requests that use this parameter instead continue to be valid.FleetAttributes.Builder serverLaunchParameters(String serverLaunchParameters)
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
serverLaunchParameters - This parameter is no longer used. Server launch parameters are now defined using the fleet's
runtime configuration . Requests that use this parameter instead continue to be valid.FleetAttributes.Builder logPaths(Collection<String> logPaths)
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift
server API ProcessReady() logParameters. See more information in the Server API Reference.
logPaths - This parameter is no longer used. Game session log paths are now defined using the Amazon
GameLift server API ProcessReady() logParameters. See more information in
the Server API Reference.FleetAttributes.Builder logPaths(String... logPaths)
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift
server API ProcessReady() logParameters. See more information in the Server API Reference.
logPaths - This parameter is no longer used. Game session log paths are now defined using the Amazon
GameLift server API ProcessReady() logParameters. See more information in
the Server API Reference.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.
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.
ProtectionPolicy,
ProtectionPolicyFleetAttributes.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.
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.
ProtectionPolicy,
ProtectionPolicyFleetAttributes.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.
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.OperatingSystem,
OperatingSystemFleetAttributes.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.
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.OperatingSystem,
OperatingSystemFleetAttributes.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
resourceCreationLimitPolicy - The new value for the ResourceCreationLimitPolicy property for this object.default FleetAttributes.Builder resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy)
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).
resourceCreationLimitPolicy - a consumer that will call methods on ResourceCreationLimitPolicy.BuilderresourceCreationLimitPolicy(ResourceCreationLimitPolicy)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.
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.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.
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.FleetAttributes.Builder stoppedActionsWithStrings(Collection<String> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAttributes.Builder stoppedActionsWithStrings(String... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAttributes.Builder stoppedActions(Collection<FleetAction> stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAttributes.Builder stoppedActions(FleetAction... stoppedActions)
A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.
stoppedActions - A list of fleet activity that has been suspended using StopFleetActions . This includes fleet auto-scaling.FleetAttributes.Builder instanceRoleArn(String instanceRoleArn)
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets.
instanceRoleArn - A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any
application that runs on an instance in the fleet--including install scripts, server processes, and
other processes--can use these permissions to interact with Amazon Web Services resources that you own
or have access to. For more information about using the role with your game server builds, see
Communicate with other Amazon Web Services resources from your fleets.FleetAttributes.Builder certificateConfiguration(CertificateConfiguration certificateConfiguration)
certificateConfiguration - The new value for the CertificateConfiguration property for this object.default FleetAttributes.Builder certificateConfiguration(Consumer<CertificateConfiguration.Builder> certificateConfiguration)
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).
certificateConfiguration - a consumer that will call methods on CertificateConfiguration.BuildercertificateConfiguration(CertificateConfiguration)FleetAttributes.Builder computeType(String computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
computeType - The type of compute resource used to host your game servers. You can use your own compute resources
with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.ComputeType,
ComputeTypeFleetAttributes.Builder computeType(ComputeType computeType)
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
computeType - The type of compute resource used to host your game servers. You can use your own compute resources
with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.ComputeType,
ComputeTypeFleetAttributes.Builder anywhereConfiguration(AnywhereConfiguration anywhereConfiguration)
anywhereConfiguration - The new value for the AnywhereConfiguration property for this object.default FleetAttributes.Builder anywhereConfiguration(Consumer<AnywhereConfiguration.Builder> anywhereConfiguration)
AnywhereConfiguration.Builder avoiding
the need to create one manually via AnywhereConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to anywhereConfiguration(AnywhereConfiguration).
anywhereConfiguration - a consumer that will call methods on AnywhereConfiguration.BuilderanywhereConfiguration(AnywhereConfiguration)FleetAttributes.Builder instanceRoleCredentialsProvider(String instanceRoleCredentialsProvider)
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. Shared credentials allow applications that are deployed with the game server
executable to communicate with other Amazon Web Services resources. This property is used only when the game
server is integrated with the server SDK version 5.x. For more information about using shared credentials,
see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider - Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. Shared credentials allow applications that are deployed with the game
server executable to communicate with other Amazon Web Services resources. This property is used only
when the game server is integrated with the server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider,
InstanceRoleCredentialsProviderFleetAttributes.Builder instanceRoleCredentialsProvider(InstanceRoleCredentialsProvider instanceRoleCredentialsProvider)
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. Shared credentials allow applications that are deployed with the game server
executable to communicate with other Amazon Web Services resources. This property is used only when the game
server is integrated with the server SDK version 5.x. For more information about using shared credentials,
see
Communicate with other Amazon Web Services resources from your fleets.
instanceRoleCredentialsProvider - Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn. Shared credentials allow applications that are deployed with the game
server executable to communicate with other Amazon Web Services resources. This property is used only
when the game server is integrated with the server SDK version 5.x. For more information about using
shared credentials, see
Communicate with other Amazon Web Services resources from your fleets.InstanceRoleCredentialsProvider,
InstanceRoleCredentialsProviderCopyright © 2023. All rights reserved.