Interface CreateContainerFleetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateContainerFleetRequest.Builder,
,CreateContainerFleetRequest> GameLiftRequest.Builder
,SdkBuilder<CreateContainerFleetRequest.Builder,
,CreateContainerFleetRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateContainerFleetRequest
-
Method Summary
Modifier and TypeMethodDescriptionbillingType
(String billingType) Indicates whether to use On-Demand or Spot instances for this fleet.billingType
(ContainerFleetBillingType billingType) Indicates whether to use On-Demand or Spot instances for this fleet.description
(String description) A meaningful description of the container fleet.fleetRoleArn
(String fleetRoleArn) The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.gameServerContainerGroupDefinitionName
(String gameServerContainerGroupDefinitionName) A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance.gameServerContainerGroupsPerInstance
(Integer gameServerContainerGroupsPerInstance) The number of times to replicate the game server container group on each fleet instance.gameSessionCreationLimitPolicy
(Consumer<GameSessionCreationLimitPolicy.Builder> gameSessionCreationLimitPolicy) A policy that limits the number of game sessions that each individual player can create on instances in this fleet.gameSessionCreationLimitPolicy
(GameSessionCreationLimitPolicy gameSessionCreationLimitPolicy) A policy that limits the number of game sessions that each individual player can create on instances in this fleet.instanceConnectionPortRange
(Consumer<ConnectionPortRange.Builder> instanceConnectionPortRange) The set of port numbers to open on each fleet instance.instanceConnectionPortRange
(ConnectionPortRange instanceConnectionPortRange) The set of port numbers to open on each fleet instance.instanceInboundPermissions
(Collection<IpPermission> instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.instanceInboundPermissions
(Consumer<IpPermission.Builder>... instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.instanceInboundPermissions
(IpPermission... instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.instanceType
(String instanceType) The Amazon EC2 instance type to use for all instances in the fleet.locations
(Collection<LocationConfiguration> locations) A set of locations to deploy container fleet instances to.locations
(Consumer<LocationConfiguration.Builder>... locations) A set of locations to deploy container fleet instances to.locations
(LocationConfiguration... locations) A set of locations to deploy container fleet instances to.logConfiguration
(Consumer<LogConfiguration.Builder> logConfiguration) A method for collecting container logs for the fleet.logConfiguration
(LogConfiguration logConfiguration) A method for collecting container logs for the fleet.metricGroups
(String... metricGroups) The name of an Amazon Web Services CloudWatch metric group to add this fleet to.metricGroups
(Collection<String> metricGroups) The name of an Amazon Web Services CloudWatch metric group to add this fleet to.newGameSessionProtectionPolicy
(String newGameSessionProtectionPolicy) Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.newGameSessionProtectionPolicy
(ProtectionPolicy newGameSessionProtectionPolicy) Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.perInstanceContainerGroupDefinitionName
(String perInstanceContainerGroupDefinitionName) The name of a container group definition resource that describes a set of axillary software.tags
(Collection<Tag> tags) A list of labels to assign to the new fleet resource.tags
(Consumer<Tag.Builder>... tags) A list of labels to assign to the new fleet resource.A list of labels to assign to the new fleet resource.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
fleetRoleArn
The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. Use an IAM service role with the
GameLiftContainerFleetPolicy
managed policy attached. For more information, see Set up an IAM service role. You can't change this fleet property after the fleet is created.IAM role ARN values use the following pattern:
arn:aws:iam::[Amazon Web Services account]:role/[role name]
.- Parameters:
fleetRoleArn
- The unique identifier for an Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. Use an IAM service role with theGameLiftContainerFleetPolicy
managed policy attached. For more information, see Set up an IAM service role. You can't change this fleet property after the fleet is created.IAM role ARN values use the following pattern:
arn:aws:iam::[Amazon Web Services account]:role/[role name]
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A meaningful description of the container fleet.
- Parameters:
description
- A meaningful description of the container fleet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameServerContainerGroupDefinitionName
CreateContainerFleetRequest.Builder gameServerContainerGroupDefinitionName(String gameServerContainerGroupDefinitionName) A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.
- Parameters:
gameServerContainerGroupDefinitionName
- A container group definition resource that describes how to deploy containers with your game server build and support software onto each fleet instance. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.Create a container group definition by calling CreateContainerGroupDefinition. This operation creates a ContainerGroupDefinition resource.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
perInstanceContainerGroupDefinitionName
CreateContainerFleetRequest.Builder perInstanceContainerGroupDefinitionName(String perInstanceContainerGroupDefinitionName) The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.
Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource.
- Parameters:
perInstanceContainerGroupDefinitionName
- The name of a container group definition resource that describes a set of axillary software. A fleet instance has one process for executables in this container group. A per-instance container group is optional. You can update the fleet to add or remove a per-instance container group at any time. You can specify the container group definition's name to use the latest version. Alternatively, provide an ARN value with a specific version number.Create a container group definition by calling https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html. This operation creates a https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html resource.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConnectionPortRange
CreateContainerFleetRequest.Builder instanceConnectionPortRange(ConnectionPortRange instanceConnectionPortRange) The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
- Parameters:
instanceConnectionPortRange
- The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
instanceConnectionPortRange
default CreateContainerFleetRequest.Builder instanceConnectionPortRange(Consumer<ConnectionPortRange.Builder> instanceConnectionPortRange) The set of port numbers to open on each fleet instance. A fleet's connection ports map to container ports that are configured in the fleet's container group definitions.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's inbound permissions port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
ConnectionPortRange.Builder
avoiding the need to create one manually viaConnectionPortRange.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceConnectionPortRange(ConnectionPortRange)
.- Parameters:
instanceConnectionPortRange
- a consumer that will call methods onConnectionPortRange.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
instanceInboundPermissions
CreateContainerFleetRequest.Builder instanceInboundPermissions(Collection<IpPermission> instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
- Parameters:
instanceInboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
instanceInboundPermissions
CreateContainerFleetRequest.Builder instanceInboundPermissions(IpPermission... instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
- Parameters:
instanceInboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
instanceInboundPermissions
CreateContainerFleetRequest.Builder instanceInboundPermissions(Consumer<IpPermission.Builder>... instanceInboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. As a best practice, when remotely accessing a fleet instance, we recommend opening ports only when you need them and closing them when you're finished.
By default, Amazon GameLift Servers calculates an optimal port range based on your fleet configuration. To use the calculated range, don't set this parameter. The values are:
-
Protocol: UDP
-
Port range: 4192 to a number calculated based on your fleet configuration. Amazon GameLift Servers uses the following formula:
4192 + [# of game server container groups per fleet instance] * [# of container ports in the game server container group definition] + [# of container ports in the game server container group definition]
You can also choose to manually set this parameter. When manually setting this parameter, you must use port numbers that match the fleet's connection port range.
If you set values manually, Amazon GameLift Servers no longer calculates a port range for you, even if you later remove the manual settings.
IpPermission.Builder
avoiding the need to create one manually viaIpPermission.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceInboundPermissions(List<IpPermission>)
.- Parameters:
instanceInboundPermissions
- a consumer that will call methods onIpPermission.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
gameServerContainerGroupsPerInstance
CreateContainerFleetRequest.Builder gameServerContainerGroupsPerInstance(Integer gameServerContainerGroupsPerInstance) The number of times to replicate the game server container group on each fleet instance.
By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
- Parameters:
gameServerContainerGroupsPerInstance
- The number of times to replicate the game server container group on each fleet instance.By default, Amazon GameLift Servers calculates the maximum number of game server container groups that can fit on each instance. This calculation is based on the CPU and memory resources of the fleet's instance type). To use the calculated maximum, don't set this parameter. If you set this number manually, Amazon GameLift Servers uses your value as long as it's less than the calculated maximum.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceType
The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity.
By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
You can't update this fleet property later.
- Parameters:
instanceType
- The Amazon EC2 instance type to use for all instances in the fleet. For multi-location fleets, the instance type must be available in the home region and all remote locations. Instance type determines the computing resources and processing power that's available to host your game servers. This includes including CPU, memory, storage, and networking capacity.By default, Amazon GameLift Servers selects an instance type that fits the needs of your container groups and is available in all selected fleet locations. You can also choose to manually set this parameter. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
You can't update this fleet property later.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
billingType
Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
By default, this property is set to
ON_DEMAND
.You can't update this fleet property later.
- Parameters:
billingType
- Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.By default, this property is set to
ON_DEMAND
.You can't update this fleet property later.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
billingType
Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
By default, this property is set to
ON_DEMAND
.You can't update this fleet property later.
- Parameters:
billingType
- Indicates whether to use On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.By default, this property is set to
ON_DEMAND
.You can't update this fleet property later.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
locations
A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such as
us-west-2
, or Local Zone names. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.- Parameters:
locations
- A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such asus-west-2
, or Local Zone names. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locations
A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such as
us-west-2
, or Local Zone names. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.- Parameters:
locations
- A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such asus-west-2
, or Local Zone names. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locations
A set of locations to deploy container fleet instances to. You can add any Amazon Web Services Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more Amazon Web Services Region codes, such as
This is a convenience method that creates an instance of theus-west-2
, or Local Zone names. Also include the fleet's home Region, which is the Amazon Web Services Region where the fleet is created. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.LocationConfiguration.Builder
avoiding the need to create one manually viaLocationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocations(List<LocationConfiguration>)
.- Parameters:
locations
- a consumer that will call methods onLocationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metricGroups
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.
- Parameters:
metricGroups
- The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metricGroups
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.
- Parameters:
metricGroups
- The name of an Amazon Web Services CloudWatch metric group to add this fleet to. You can use a metric group to aggregate metrics for multiple fleets. You can specify an existing metric group name or use a new name to create a new metric group. Each fleet can have only one metric group, but you can change this value at any time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
newGameSessionProtectionPolicy
CreateContainerFleetRequest.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to
NoProtection
.- Parameters:
newGameSessionProtectionPolicy
- Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to
NoProtection
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
newGameSessionProtectionPolicy
CreateContainerFleetRequest.Builder newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.
-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to
NoProtection
.- Parameters:
newGameSessionProtectionPolicy
- Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players. Amazon GameLift Servers might prompt an instance shutdown when scaling down fleet capacity or when retiring unhealthy instances. You can also set game session protection for individual game sessions using UpdateGameSession.-
NoProtection -- Game sessions can be shut down during active gameplay.
-
FullProtection -- Game sessions in
ACTIVE
status can't be shut down.
By default, this property is set to
NoProtection
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
gameSessionCreationLimitPolicy
CreateContainerFleetRequest.Builder gameSessionCreationLimitPolicy(GameSessionCreationLimitPolicy gameSessionCreationLimitPolicy) A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
- Parameters:
gameSessionCreationLimitPolicy
- A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameSessionCreationLimitPolicy
default CreateContainerFleetRequest.Builder gameSessionCreationLimitPolicy(Consumer<GameSessionCreationLimitPolicy.Builder> gameSessionCreationLimitPolicy) A policy that limits the number of game sessions that each individual player can create on instances in this fleet. The limit applies for a specified span of time.
This is a convenience method that creates an instance of theGameSessionCreationLimitPolicy.Builder
avoiding the need to create one manually viaGameSessionCreationLimitPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togameSessionCreationLimitPolicy(GameSessionCreationLimitPolicy)
.- Parameters:
gameSessionCreationLimitPolicy
- a consumer that will call methods onGameSessionCreationLimitPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logConfiguration
A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to
CLOUDWATCH
.Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see
FleetRoleArn)
.- Parameters:
logConfiguration
- A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to
CLOUDWATCH
.Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see
FleetRoleArn)
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
logConfiguration
default CreateContainerFleetRequest.Builder logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration) A method for collecting container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs. You can select from the following methods:
-
CLOUDWATCH
-- Send logs to an Amazon CloudWatch log group that you define. Each container emits a log stream, which is organized in the log group. -
S3
-- Store logs in an Amazon S3 bucket that you define. -
NONE
-- Don't collect container logs.
By default, this property is set to
CLOUDWATCH
.Amazon GameLift Servers requires permissions to send logs other Amazon Web Services services in your account. These permissions are included in the IAM fleet role for this container fleet (see
This is a convenience method that creates an instance of theFleetRoleArn)
.LogConfiguration.Builder
avoiding the need to create one manually viaLogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfiguration(LogConfiguration)
.- Parameters:
logConfiguration
- a consumer that will call methods onLogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
tags
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
- Parameters:
tags
- A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
- Parameters:
tags
- A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateContainerFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateContainerFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-