Class CfnFleet.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFleet>
- Enclosing class:
CfnFleet
CfnFleet
.-
Method Summary
Modifier and TypeMethodDescriptionanywhereConfiguration
(IResolvable anywhereConfiguration) Amazon GameLift Anywhere configuration options.anywhereConfiguration
(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration) Amazon GameLift Anywhere configuration options.applyCapacity
(String applyCapacity) Current resource capacity settings for managed EC2 fleets and container fleets.build()
A unique identifier for a build to be deployed on the new fleet.certificateConfiguration
(IResolvable certificateConfiguration) Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.certificateConfiguration
(CfnFleet.CertificateConfigurationProperty certificateConfiguration) Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.computeType
(String computeType) The type of compute resource used to host your game servers.containerGroupsConfiguration
(IResolvable containerGroupsConfiguration) This data type is used with the Amazon GameLift containers feature, which is currently in public preview..containerGroupsConfiguration
(CfnFleet.ContainerGroupsConfigurationProperty containerGroupsConfiguration) This data type is used with the Amazon GameLift containers feature, which is currently in public preview..static CfnFleet.Builder
description
(String description) A description for the fleet.desiredEc2Instances
(Number desiredEc2Instances) The number of EC2 instances that you want this fleet to host.ec2InboundPermissions
(List<? extends Object> ec2InboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.ec2InboundPermissions
(IResolvable ec2InboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.ec2InstanceType
(String ec2InstanceType) The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.Indicates whether to use On-Demand or Spot instances for this fleet.instanceRoleArn
(String instanceRoleArn) A unique identifier for an IAM role with access permissions to other AWS services.instanceRoleCredentialsProvider
(String instanceRoleCredentialsProvider) Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.A set of remote locations to deploy additional instances to and manage as a multi-location fleet.locations
(IResolvable locations) A set of remote locations to deploy additional instances to and manage as a multi-location fleet.Deprecated.this property has been deprecatedThe maximum number of instances that are allowed in the specified fleet location.metricGroups
(List<String> metricGroups) The name of an AWS CloudWatch metric group to add this fleet to.The minimum number of instances that are allowed in the specified fleet location.A descriptive label that is associated with a fleet.newGameSessionProtectionPolicy
(String newGameSessionProtectionPolicy) The status of termination protection for active game sessions on the fleet.peerVpcAwsAccountId
(String peerVpcAwsAccountId) Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.resourceCreationLimitPolicy
(IResolvable resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.resourceCreationLimitPolicy
(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.runtimeConfiguration
(IResolvable runtimeConfiguration) Instructions for how to launch and maintain server processes on instances in the fleet.runtimeConfiguration
(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration) Instructions for how to launch and maintain server processes on instances in the fleet.scalingPolicies
(List<? extends Object> scalingPolicies) Rule that controls how a fleet is scaled.scalingPolicies
(IResolvable scalingPolicies) Rule that controls how a fleet is scaled.The unique identifier for a Realtime configuration script to be deployed on fleet instances.serverLaunchParameters
(String serverLaunchParameters) Deprecated.this property has been deprecatedserverLaunchPath
(String serverLaunchPath) Deprecated.this property has been deprecated
-
Method Details
-
create
@Stability(Stable) public static CfnFleet.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnFleet.Builder
.
-
name
A descriptive label that is associated with a fleet.Fleet names do not need to be unique.
- Parameters:
name
- A descriptive label that is associated with a fleet. This parameter is required.- Returns:
this
- See Also:
-
anywhereConfiguration
Amazon GameLift Anywhere configuration options.- Parameters:
anywhereConfiguration
- Amazon GameLift Anywhere configuration options. This parameter is required.- Returns:
this
- See Also:
-
anywhereConfiguration
@Stability(Stable) public CfnFleet.Builder anywhereConfiguration(CfnFleet.AnywhereConfigurationProperty anywhereConfiguration) Amazon GameLift Anywhere configuration options.- Parameters:
anywhereConfiguration
- Amazon GameLift Anywhere configuration options. This parameter is required.- Returns:
this
- See Also:
-
applyCapacity
Current resource capacity settings for managed EC2 fleets and container fleets.For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- Parameters:
applyCapacity
- Current resource capacity settings for managed EC2 fleets and container fleets. This parameter is required.- Returns:
this
- See Also:
-
buildId
A unique identifier for a build to be deployed on the new fleet.If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a
READY
status. This fleet setting cannot be changed once the fleet is created.- Parameters:
buildId
- A unique identifier for a build to be deployed on the new fleet. This parameter is required.- Returns:
this
- See Also:
-
certificateConfiguration
@Stability(Stable) public CfnFleet.Builder certificateConfiguration(IResolvable certificateConfiguration) Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
isDISABLED
. You can't change this property after you create the fleet.AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .
- Parameters:
certificateConfiguration
- Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. This parameter is required.- Returns:
this
- See Also:
-
certificateConfiguration
@Stability(Stable) public CfnFleet.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration) Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
isDISABLED
. You can't change this property after you create the fleet.AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the AWS Certificate Manager User Guide .
- Parameters:
certificateConfiguration
- Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. This parameter is required.- Returns:
this
- See Also:
-
computeType
The type of compute resource used to host your game servers.EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.CONTAINER
– Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify theContainerGroupsConfiguration
parameter.ANYWHERE
– Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set theAnywhereConfiguration
parameter.
- Parameters:
computeType
- The type of compute resource used to host your game servers. This parameter is required.- Returns:
this
- See Also:
-
containerGroupsConfiguration
@Stability(Stable) public CfnFleet.Builder containerGroupsConfiguration(IResolvable containerGroupsConfiguration) This data type is used with the Amazon GameLift containers feature, which is currently in public preview..Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- Parameters:
containerGroupsConfiguration
- This data type is used with the Amazon GameLift containers feature, which is currently in public preview.. This parameter is required.- Returns:
this
- See Also:
-
containerGroupsConfiguration
@Stability(Stable) public CfnFleet.Builder containerGroupsConfiguration(CfnFleet.ContainerGroupsConfigurationProperty containerGroupsConfiguration) This data type is used with the Amazon GameLift containers feature, which is currently in public preview..Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- Parameters:
containerGroupsConfiguration
- This data type is used with the Amazon GameLift containers feature, which is currently in public preview.. This parameter is required.- Returns:
this
- See Also:
-
description
A description for the fleet.- Parameters:
description
- A description for the fleet. This parameter is required.- Returns:
this
- See Also:
-
desiredEc2Instances
The number of EC2 instances that you want this fleet to host.When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
- Parameters:
desiredEc2Instances
- The number of EC2 instances that you want this fleet to host. This parameter is required.- Returns:
this
- See Also:
-
ec2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call
UpdateFleetPortSettings
to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
- Parameters:
ec2InboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. This parameter is required.- Returns:
this
- See Also:
-
ec2InboundPermissions
@Stability(Stable) public CfnFleet.Builder ec2InboundPermissions(List<? extends Object> ec2InboundPermissions) The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call
UpdateFleetPortSettings
to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
- Parameters:
ec2InboundPermissions
- The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. This parameter is required.- Returns:
this
- See Also:
-
ec2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
- Parameters:
ec2InstanceType
- The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets. This parameter is required.- Returns:
this
- See Also:
-
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.- Parameters:
fleetType
- Indicates whether to use On-Demand or Spot instances for this fleet. This parameter is required.- Returns:
this
- See Also:
-
instanceRoleArn
A unique identifier for an IAM role with access permissions to other AWS 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 AWS resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other AWS resources from your fleets . This attribute is used with fleets where
ComputeType
is "EC2" or "Container".- Parameters:
instanceRoleArn
- A unique identifier for an IAM role with access permissions to other AWS services. This parameter is required.- Returns:
this
- See Also:
-
instanceRoleCredentialsProvider
@Stability(Stable) public CfnFleet.Builder instanceRoleCredentialsProvider(String instanceRoleCredentialsProvider) Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS 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 AWS resources from your fleets . This attribute is used with fleets where
ComputeType
is "EC2" or "Container".- Parameters:
instanceRoleCredentialsProvider
- Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
. This parameter is required.- Returns:
this
- See Also:
-
locations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.- Parameters:
locations
- A set of remote locations to deploy additional instances to and manage as a multi-location fleet. This parameter is required.- Returns:
this
- See Also:
-
locations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.- Parameters:
locations
- A set of remote locations to deploy additional instances to and manage as a multi-location fleet. This parameter is required.- Returns:
this
- See Also:
-
logPaths
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used.When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- Parameters:
logPaths
- This parameter is no longer used. This parameter is required.- Returns:
this
- See Also:
-
maxSize
The maximum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 1.
- Parameters:
maxSize
- The maximum number of instances that are allowed in the specified fleet location. This parameter is required.- Returns:
this
- See Also:
-
metricGroups
The name of an AWS CloudWatch metric group to add this fleet to.A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
- Parameters:
metricGroups
- The name of an AWS CloudWatch metric group to add this fleet to. This parameter is required.- Returns:
this
- See Also:
-
minSize
The minimum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 0.
- Parameters:
minSize
- The minimum number of instances that are allowed in the specified fleet location. This parameter is required.- Returns:
this
- See Also:
-
newGameSessionProtectionPolicy
@Stability(Stable) public CfnFleet.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) The status of termination protection for active game sessions on the fleet.By default, this property is set to
NoProtection
.- NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
- FullProtection - Game sessions in
ACTIVE
status cannot be terminated during a scale-down event.
- Parameters:
newGameSessionProtectionPolicy
- The status of termination protection for active game sessions on the fleet. This parameter is required.- Returns:
this
- See Also:
-
peerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.You can find your account ID in the AWS Management Console under account settings.
- Parameters:
peerVpcAwsAccountId
- Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. This parameter is required.- Returns:
this
- See Also:
-
peerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console . Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
- Parameters:
peerVpcId
- A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. This parameter is required.- Returns:
this
- See Also:
-
resourceCreationLimitPolicy
@Stability(Stable) public CfnFleet.Builder resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.- Parameters:
resourceCreationLimitPolicy
- A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. This parameter is required.- Returns:
this
- See Also:
-
resourceCreationLimitPolicy
@Stability(Stable) public CfnFleet.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy) A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.- Parameters:
resourceCreationLimitPolicy
- A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time. This parameter is required.- Returns:
this
- See Also:
-
runtimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet.The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The
RuntimeConfiguration
parameter is required unless the fleet is being configured using the older parametersServerLaunchPath
andServerLaunchParameters
, which are still supported for backward compatibility.- Parameters:
runtimeConfiguration
- Instructions for how to launch and maintain server processes on instances in the fleet. This parameter is required.- Returns:
this
- See Also:
-
runtimeConfiguration
@Stability(Stable) public CfnFleet.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration) Instructions for how to launch and maintain server processes on instances in the fleet.The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The
RuntimeConfiguration
parameter is required unless the fleet is being configured using the older parametersServerLaunchPath
andServerLaunchParameters
, which are still supported for backward compatibility.- Parameters:
runtimeConfiguration
- Instructions for how to launch and maintain server processes on instances in the fleet. This parameter is required.- Returns:
this
- See Also:
-
scalingPolicies
Rule that controls how a fleet is scaled.Scaling policies are uniquely identified by the combination of name and fleet ID.
- Parameters:
scalingPolicies
- Rule that controls how a fleet is scaled. This parameter is required.- Returns:
this
- See Also:
-
scalingPolicies
Rule that controls how a fleet is scaled.Scaling policies are uniquely identified by the combination of name and fleet ID.
- Parameters:
scalingPolicies
- Rule that controls how a fleet is scaled. This parameter is required.- Returns:
this
- See Also:
-
scriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances.You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.
You can't use the
!Ref
command to reference a script created with a CloudFormation template for the fleet propertyScriptId
. Instead, useFn::GetAtt Script.Arn
orFn::GetAtt Script.Id
to retrieve either of these properties as input forScriptId
. Alternatively, enter aScriptId
string manually.- Parameters:
scriptId
- The unique identifier for a Realtime configuration script to be deployed on fleet instances. This parameter is required.- Returns:
this
- See Also:
-
serverLaunchParameters
@Stability(Deprecated) @Deprecated public CfnFleet.Builder serverLaunchParameters(String serverLaunchParameters) Deprecated.this property has been deprecated(deprecated) This parameter is no longer used but is retained for backward compatibility.Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- Parameters:
serverLaunchParameters
- This parameter is no longer used but is retained for backward compatibility. This parameter is required.- Returns:
this
- See Also:
-
serverLaunchPath
@Stability(Deprecated) @Deprecated public CfnFleet.Builder serverLaunchPath(String serverLaunchPath) Deprecated.this property has been deprecated(deprecated) This parameter is no longer used.Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- Parameters:
serverLaunchPath
- This parameter is no longer used. This parameter is required.- Returns:
this
- See Also:
-
build
-