Package software.amazon.awscdk.services.gamelift

Class CfnContainerFleetProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerFleetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerFleetProps>

Enclosing interface:

CfnContainerFleetProps

@Stability(Stable)
public static final class CfnContainerFleetProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerFleetProps>

A builder for CfnContainerFleetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnContainerFleetProps.Builder	billingType(String billingType)	Sets the value of CfnContainerFleetProps.getBillingType()
CfnContainerFleetProps	build()	Builds the configured instance.
CfnContainerFleetProps.Builder	deploymentConfiguration(IResolvable deploymentConfiguration)	Sets the value of CfnContainerFleetProps.getDeploymentConfiguration()
CfnContainerFleetProps.Builder	deploymentConfiguration(CfnContainerFleet.DeploymentConfigurationProperty deploymentConfiguration)	Sets the value of CfnContainerFleetProps.getDeploymentConfiguration()
CfnContainerFleetProps.Builder	description(String description)	Sets the value of CfnContainerFleetProps.getDescription()
CfnContainerFleetProps.Builder	fleetRoleArn(String fleetRoleArn)	Sets the value of CfnContainerFleetProps.getFleetRoleArn()
CfnContainerFleetProps.Builder	gameServerContainerGroupDefinitionName(String gameServerContainerGroupDefinitionName)	Sets the value of CfnContainerFleetProps.getGameServerContainerGroupDefinitionName()
CfnContainerFleetProps.Builder	gameServerContainerGroupsPerInstance(Number gameServerContainerGroupsPerInstance)	Sets the value of CfnContainerFleetProps.getGameServerContainerGroupsPerInstance()
CfnContainerFleetProps.Builder	gameSessionCreationLimitPolicy(IResolvable gameSessionCreationLimitPolicy)	Sets the value of CfnContainerFleetProps.getGameSessionCreationLimitPolicy()
CfnContainerFleetProps.Builder	gameSessionCreationLimitPolicy(CfnContainerFleet.GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicy)	Sets the value of CfnContainerFleetProps.getGameSessionCreationLimitPolicy()
CfnContainerFleetProps.Builder	instanceConnectionPortRange(IResolvable instanceConnectionPortRange)	Sets the value of CfnContainerFleetProps.getInstanceConnectionPortRange()
CfnContainerFleetProps.Builder	instanceConnectionPortRange(CfnContainerFleet.ConnectionPortRangeProperty instanceConnectionPortRange)	Sets the value of CfnContainerFleetProps.getInstanceConnectionPortRange()
CfnContainerFleetProps.Builder	instanceInboundPermissions(List<? extends Object> instanceInboundPermissions)	Sets the value of CfnContainerFleetProps.getInstanceInboundPermissions()
CfnContainerFleetProps.Builder	instanceInboundPermissions(IResolvable instanceInboundPermissions)	Sets the value of CfnContainerFleetProps.getInstanceInboundPermissions()
CfnContainerFleetProps.Builder	instanceType(String instanceType)	Sets the value of CfnContainerFleetProps.getInstanceType()
CfnContainerFleetProps.Builder	locations(List<? extends Object> locations)	Sets the value of CfnContainerFleetProps.getLocations()
CfnContainerFleetProps.Builder	locations(IResolvable locations)	Sets the value of CfnContainerFleetProps.getLocations()
CfnContainerFleetProps.Builder	logConfiguration(IResolvable logConfiguration)	Sets the value of CfnContainerFleetProps.getLogConfiguration()
CfnContainerFleetProps.Builder	logConfiguration(CfnContainerFleet.LogConfigurationProperty logConfiguration)	Sets the value of CfnContainerFleetProps.getLogConfiguration()
CfnContainerFleetProps.Builder	metricGroups(List<String> metricGroups)	Sets the value of CfnContainerFleetProps.getMetricGroups()
CfnContainerFleetProps.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)	Sets the value of CfnContainerFleetProps.getNewGameSessionProtectionPolicy()
CfnContainerFleetProps.Builder	perInstanceContainerGroupDefinitionName(String perInstanceContainerGroupDefinitionName)	Sets the value of CfnContainerFleetProps.getPerInstanceContainerGroupDefinitionName()
CfnContainerFleetProps.Builder	scalingPolicies(List<? extends Object> scalingPolicies)	Sets the value of CfnContainerFleetProps.getScalingPolicies()
CfnContainerFleetProps.Builder	scalingPolicies(IResolvable scalingPolicies)	Sets the value of CfnContainerFleetProps.getScalingPolicies()
CfnContainerFleetProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnContainerFleetProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

fleetRoleArn

@Stability(Stable)
public CfnContainerFleetProps.Builder fleetRoleArn(String fleetRoleArn)

Sets the value of CfnContainerFleetProps.getFleetRoleArn()

Parameters:

fleetRoleArn - A unique identifier for an AWS IAM role that manages access to your AWS services. This parameter is required. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.

Returns:

this

billingType

@Stability(Stable)
public CfnContainerFleetProps.Builder billingType(String billingType)

Sets the value of CfnContainerFleetProps.getBillingType()

Parameters:

billingType - Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet.

Returns:

this

deploymentConfiguration

@Stability(Stable)
public CfnContainerFleetProps.Builder deploymentConfiguration(IResolvable deploymentConfiguration)

Sets the value of CfnContainerFleetProps.getDeploymentConfiguration()

Parameters:

deploymentConfiguration - Provides details about how to drain old tasks and replace them with new updated tasks.

Returns:

this

deploymentConfiguration

@Stability(Stable)
public CfnContainerFleetProps.Builder deploymentConfiguration(CfnContainerFleet.DeploymentConfigurationProperty deploymentConfiguration)

Sets the value of CfnContainerFleetProps.getDeploymentConfiguration()

Parameters:

deploymentConfiguration - Provides details about how to drain old tasks and replace them with new updated tasks.

Returns:

this

description

@Stability(Stable)
public CfnContainerFleetProps.Builder description(String description)

Sets the value of CfnContainerFleetProps.getDescription()

Parameters:

description - A human-readable description of a fleet.

Returns:

this

gameServerContainerGroupDefinitionName

@Stability(Stable)
public CfnContainerFleetProps.Builder gameServerContainerGroupDefinitionName(String gameServerContainerGroupDefinitionName)

Sets the value of CfnContainerFleetProps.getGameServerContainerGroupDefinitionName()

Parameters:

gameServerContainerGroupDefinitionName - The name of the container group definition that will be created per game server. You must specify GAME_SERVER container group. You have the option to also specify one PER_INSTANCE container group.

Returns:

this

gameServerContainerGroupsPerInstance

@Stability(Stable)
public CfnContainerFleetProps.Builder gameServerContainerGroupsPerInstance(Number gameServerContainerGroupsPerInstance)

Sets the value of CfnContainerFleetProps.getGameServerContainerGroupsPerInstance()

Parameters:

gameServerContainerGroupsPerInstance - The number of desired game server container groups per instance, a number between 1-5000.

Returns:

this

gameSessionCreationLimitPolicy

@Stability(Stable)
public CfnContainerFleetProps.Builder gameSessionCreationLimitPolicy(IResolvable gameSessionCreationLimitPolicy)

Sets the value of CfnContainerFleetProps.getGameSessionCreationLimitPolicy()

Parameters:

gameSessionCreationLimitPolicy - A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

Returns:

this

gameSessionCreationLimitPolicy

@Stability(Stable)
public CfnContainerFleetProps.Builder gameSessionCreationLimitPolicy(CfnContainerFleet.GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicy)

Sets the value of CfnContainerFleetProps.getGameSessionCreationLimitPolicy()

Parameters:

gameSessionCreationLimitPolicy - A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".

The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

Returns:

this

instanceConnectionPortRange

@Stability(Stable)
public CfnContainerFleetProps.Builder instanceConnectionPortRange(IResolvable instanceConnectionPortRange)

Sets the value of CfnContainerFleetProps.getInstanceConnectionPortRange()

Parameters:

instanceConnectionPortRange - Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.

Returns:

this

instanceConnectionPortRange

@Stability(Stable)
public CfnContainerFleetProps.Builder instanceConnectionPortRange(CfnContainerFleet.ConnectionPortRangeProperty instanceConnectionPortRange)

Sets the value of CfnContainerFleetProps.getInstanceConnectionPortRange()

Parameters:

instanceConnectionPortRange - Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet.

Returns:

this

instanceInboundPermissions

@Stability(Stable)
public CfnContainerFleetProps.Builder instanceInboundPermissions(IResolvable instanceInboundPermissions)

Sets the value of CfnContainerFleetProps.getInstanceInboundPermissions()

Parameters:

instanceInboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

Returns:

this

instanceInboundPermissions

@Stability(Stable)
public CfnContainerFleetProps.Builder instanceInboundPermissions(List<? extends Object> instanceInboundPermissions)

Sets the value of CfnContainerFleetProps.getInstanceInboundPermissions()

Parameters:

instanceInboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.

Returns:

this

instanceType

@Stability(Stable)
public CfnContainerFleetProps.Builder instanceType(String instanceType)

Sets the value of CfnContainerFleetProps.getInstanceType()

Parameters:

instanceType - The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

this

locations

@Stability(Stable)
public CfnContainerFleetProps.Builder locations(IResolvable locations)

Sets the value of CfnContainerFleetProps.getLocations()

Parameters:

locations - the value to be set.

Returns:

this

locations

@Stability(Stable)
public CfnContainerFleetProps.Builder locations(List<? extends Object> locations)

Sets the value of CfnContainerFleetProps.getLocations()

Parameters:

locations - the value to be set.

Returns:

this

logConfiguration

@Stability(Stable)
public CfnContainerFleetProps.Builder logConfiguration(IResolvable logConfiguration)

Sets the value of CfnContainerFleetProps.getLogConfiguration()

Parameters:

logConfiguration - A policy the location and provider of logs from the fleet.

Returns:

this

logConfiguration

@Stability(Stable)
public CfnContainerFleetProps.Builder logConfiguration(CfnContainerFleet.LogConfigurationProperty logConfiguration)

Sets the value of CfnContainerFleetProps.getLogConfiguration()

Parameters:

logConfiguration - A policy the location and provider of logs from the fleet.

Returns:

this

metricGroups

@Stability(Stable)
public CfnContainerFleetProps.Builder metricGroups(List<String> metricGroups)

Sets the value of CfnContainerFleetProps.getMetricGroups()

Parameters:

metricGroups - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.

Returns:

this

newGameSessionProtectionPolicy

@Stability(Stable)
public CfnContainerFleetProps.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

Sets the value of CfnContainerFleetProps.getNewGameSessionProtectionPolicy()

Parameters:

newGameSessionProtectionPolicy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.

Returns:

this

perInstanceContainerGroupDefinitionName

@Stability(Stable)
public CfnContainerFleetProps.Builder perInstanceContainerGroupDefinitionName(String perInstanceContainerGroupDefinitionName)

Sets the value of CfnContainerFleetProps.getPerInstanceContainerGroupDefinitionName()

Parameters:

perInstanceContainerGroupDefinitionName - The name of the container group definition that will be created per instance. This field is optional if you specify GameServerContainerGroupDefinitionName.

Returns:

this

scalingPolicies

@Stability(Stable)
public CfnContainerFleetProps.Builder scalingPolicies(IResolvable scalingPolicies)

Sets the value of CfnContainerFleetProps.getScalingPolicies()

Parameters:

scalingPolicies - A list of rules that control how a fleet is scaled.

Returns:

this

scalingPolicies

@Stability(Stable)
public CfnContainerFleetProps.Builder scalingPolicies(List<? extends Object> scalingPolicies)

Sets the value of CfnContainerFleetProps.getScalingPolicies()

Parameters:

scalingPolicies - A list of rules that control how a fleet is scaled.

Returns:

this

tags

@Stability(Stable)
public CfnContainerFleetProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnContainerFleetProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource.

Returns:

this

build

@Stability(Stable)
public CfnContainerFleetProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerFleetProps>

Returns:

a new instance of CfnContainerFleetProps

Throws:

NullPointerException - if any required attribute was not provided