Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Class CfnContainerFleetMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnContainerFleetMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerFleetMixinProps>

Enclosing interface:

CfnContainerFleetMixinProps

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

A builder for CfnContainerFleetMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

billingType

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

Sets the value of CfnContainerFleetMixinProps.getBillingType()

Parameters:

billingType - Indicates whether the fleet uses On-Demand or Spot instances for this fleet. Learn more about when to use On-Demand versus Spot Instances . You can't update this fleet property.

By default, this property is set to ON_DEMAND .

Returns:

this

deploymentConfiguration

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

Sets the value of CfnContainerFleetMixinProps.getDeploymentConfiguration()

Parameters:

deploymentConfiguration - Set of rules for processing a deployment for a container fleet update.

Returns:

this

deploymentConfiguration

@Stability(Stable)
public CfnContainerFleetMixinProps.Builder deploymentConfiguration(CfnContainerFleetPropsMixin.DeploymentConfigurationProperty deploymentConfiguration)

Sets the value of CfnContainerFleetMixinProps.getDeploymentConfiguration()

Parameters:

deploymentConfiguration - Set of rules for processing a deployment for a container fleet update.

Returns:

this

description

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

Sets the value of CfnContainerFleetMixinProps.getDescription()

Parameters:

description - A meaningful description of the container fleet.

Returns:

this

fleetRoleArn

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

Sets the value of CfnContainerFleetMixinProps.getFleetRoleArn()

Parameters:

fleetRoleArn - The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers. See Set up an IAM service role . This fleet property can't be changed.

Returns:

this

gameServerContainerGroupDefinitionName

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

Sets the value of CfnContainerFleetMixinProps.getGameServerContainerGroupDefinitionName()

Parameters:

gameServerContainerGroupDefinitionName - The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

Returns:

this

gameServerContainerGroupsPerInstance

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

Sets the value of CfnContainerFleetMixinProps.getGameServerContainerGroupsPerInstance()

Parameters:

gameServerContainerGroupsPerInstance - The number of times to replicate the game server container group on each fleet instance.

Returns:

this

gameSessionCreationLimitPolicy

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

Sets the value of CfnContainerFleetMixinProps.getGameSessionCreationLimitPolicy()

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:

this

gameSessionCreationLimitPolicy

@Stability(Stable)
public CfnContainerFleetMixinProps.Builder gameSessionCreationLimitPolicy(CfnContainerFleetPropsMixin.GameSessionCreationLimitPolicyProperty gameSessionCreationLimitPolicy)

Sets the value of CfnContainerFleetMixinProps.getGameSessionCreationLimitPolicy()

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:

this

instanceConnectionPortRange

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

Sets the value of CfnContainerFleetMixinProps.getInstanceConnectionPortRange()

Parameters:

instanceConnectionPortRange - The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

Returns:

this

instanceConnectionPortRange

@Stability(Stable)
public CfnContainerFleetMixinProps.Builder instanceConnectionPortRange(CfnContainerFleetPropsMixin.ConnectionPortRangeProperty instanceConnectionPortRange)

Sets the value of CfnContainerFleetMixinProps.getInstanceConnectionPortRange()

Parameters:

instanceConnectionPortRange - The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.

Returns:

this

instanceInboundPermissions

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

Sets the value of CfnContainerFleetMixinProps.getInstanceInboundPermissions()

Parameters:

instanceInboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

Returns:

this

instanceInboundPermissions

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

Sets the value of CfnContainerFleetMixinProps.getInstanceInboundPermissions()

Parameters:

instanceInboundPermissions - The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

Returns:

this

instanceType

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

Sets the value of CfnContainerFleetMixinProps.getInstanceType()

Parameters:

instanceType - The Amazon EC2 instance type to use for all instances in the fleet. 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. You can't update this fleet property.

Returns:

this

locations

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

Sets the value of CfnContainerFleetMixinProps.getLocations()

Parameters:

locations - the value to be set.

Returns:

this

locations

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

Sets the value of CfnContainerFleetMixinProps.getLocations()

Parameters:

locations - the value to be set.

Returns:

this

logConfiguration

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

Sets the value of CfnContainerFleetMixinProps.getLogConfiguration()

Parameters:

logConfiguration - The method that is used to collect container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.

• 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.

Returns:

this

logConfiguration

@Stability(Stable)
public CfnContainerFleetMixinProps.Builder logConfiguration(CfnContainerFleetPropsMixin.LogConfigurationProperty logConfiguration)

Sets the value of CfnContainerFleetMixinProps.getLogConfiguration()

Parameters:

logConfiguration - The method that is used to collect container logs for the fleet. Amazon GameLift Servers saves all standard output for each container in logs, including game session logs.

• 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.

Returns:

this

metricGroups

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

Sets the value of CfnContainerFleetMixinProps.getMetricGroups()

Parameters:

metricGroups - The name of an AWS CloudWatch metric group to add this fleet to. Metric groups aggregate metrics for multiple fleets.

Returns:

this

newGameSessionProtectionPolicy

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

Sets the value of CfnContainerFleetMixinProps.getNewGameSessionProtectionPolicy()

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.

Returns:

this

perInstanceContainerGroupDefinitionName

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

Sets the value of CfnContainerFleetMixinProps.getPerInstanceContainerGroupDefinitionName()

Parameters:

perInstanceContainerGroupDefinitionName - The name of the fleet's per-instance container group definition.

Returns:

this

playerGatewayMode

@Stability(Stable)
public CfnContainerFleetMixinProps.Builder playerGatewayMode(String playerGatewayMode)

Sets the value of CfnContainerFleetMixinProps.getPlayerGatewayMode()

Parameters:

playerGatewayMode - The player gateway mode for the container fleet.

Returns:

this

scalingPolicies

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

Sets the value of CfnContainerFleetMixinProps.getScalingPolicies()

Parameters:

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

Returns:

this

scalingPolicies

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

Sets the value of CfnContainerFleetMixinProps.getScalingPolicies()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnContainerFleetMixinProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnContainerFleetMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnContainerFleetMixinProps

Throws:

NullPointerException - if any required attribute was not provided