@Stability(value=Stable) public static final class CfnFleetProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFleetProps>
CfnFleetProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnFleetProps.Builder buildId(String buildId)
CfnFleetProps.getBuildId()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.this@Stability(value=Stable) public CfnFleetProps.Builder certificateConfiguration(CfnFleet.CertificateConfigurationProperty certificateConfiguration)
CfnFleetProps.getCertificateConfiguration()certificateConfiguration - Indicates whether to generate a TLS/SSL certificate for the new fleet.
TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication .
Note: This feature requires the AWS Certificate Manager service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported region error.
this@Stability(value=Stable) public CfnFleetProps.Builder certificateConfiguration(IResolvable certificateConfiguration)
CfnFleetProps.getCertificateConfiguration()certificateConfiguration - Indicates whether to generate a TLS/SSL certificate for the new fleet.
TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication .
Note: This feature requires the AWS Certificate Manager service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported region error.
this@Stability(value=Stable) public CfnFleetProps.Builder description(String description)
CfnFleetProps.getDescription()description - A human-readable description of the fleet.this@Stability(value=Stable) public CfnFleetProps.Builder desiredEc2Instances(Number desiredEc2Instances)
CfnFleetProps.getDesiredEc2Instances()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.this@Stability(value=Stable) public CfnFleetProps.Builder ec2InboundPermissions(IResolvable ec2InboundPermissions)
CfnFleetProps.getEc2InboundPermissions()ec2InboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.this@Stability(value=Stable) public CfnFleetProps.Builder ec2InboundPermissions(List<? extends Object> ec2InboundPermissions)
CfnFleetProps.getEc2InboundPermissions()ec2InboundPermissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.this@Stability(value=Stable) public CfnFleetProps.Builder ec2InstanceType(String ec2InstanceType)
CfnFleetProps.getEc2InstanceType()ec2InstanceType - The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
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.this@Stability(value=Stable) public CfnFleetProps.Builder fleetType(String fleetType)
CfnFleetProps.getFleetType()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 property cannot be changed after the fleet is created.this@Stability(value=Stable) public CfnFleetProps.Builder instanceRoleArn(String instanceRoleArn)
CfnFleetProps.getInstanceRoleArn()instanceRoleArn - A unique identifier for an IAM role that manages access to your AWS services.
With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console . Learn more about using on-box credentials for your game servers at Access external resources from a game server . This property cannot be changed after the fleet is created.this@Stability(value=Stable) public CfnFleetProps.Builder locations(IResolvable locations)
CfnFleetProps.getLocations()locations - A set of remote locations to deploy additional instances to and manage as part of the fleet.
This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, omit this parameter.this@Stability(value=Stable) public CfnFleetProps.Builder locations(List<? extends Object> locations)
CfnFleetProps.getLocations()locations - A set of remote locations to deploy additional instances to and manage as part of the fleet.
This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2 . To create a fleet with instances in the home Region only, omit this parameter.this@Stability(value=Stable) public CfnFleetProps.Builder maxSize(Number maxSize)
CfnFleetProps.getMaxSize()maxSize - The maximum value that is allowed for the fleet's instance count.
When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.this@Stability(value=Stable) public CfnFleetProps.Builder metricGroups(List<String> metricGroups)
CfnFleetProps.getMetricGroups()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.this@Stability(value=Stable) public CfnFleetProps.Builder minSize(Number minSize)
CfnFleetProps.getMinSize()minSize - The minimum value allowed for the fleet's instance count.
When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.this@Stability(value=Stable) public CfnFleetProps.Builder name(String name)
CfnFleetProps.getName()name - A descriptive label that is associated with a fleet.
Fleet names do not need to be unique.this@Stability(value=Stable) public CfnFleetProps.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
CfnFleetProps.getNewGameSessionProtectionPolicy()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.this@Stability(value=Stable) public CfnFleetProps.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)
CfnFleetProps.getPeerVpcAwsAccountId()peerVpcAwsAccountId - Used when peering your 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.this@Stability(value=Stable) public CfnFleetProps.Builder peerVpcId(String peerVpcId)
CfnFleetProps.getPeerVpcId()peerVpcId - A unique identifier for a VPC with resources to be accessed by your 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 GameLift Fleets .this@Stability(value=Stable) public CfnFleetProps.Builder resourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty resourceCreationLimitPolicy)
CfnFleetProps.getResourceCreationLimitPolicy()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@Stability(value=Stable) public CfnFleetProps.Builder resourceCreationLimitPolicy(IResolvable resourceCreationLimitPolicy)
CfnFleetProps.getResourceCreationLimitPolicy()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@Stability(value=Stable) public CfnFleetProps.Builder runtimeConfiguration(CfnFleet.RuntimeConfigurationProperty runtimeConfiguration)
CfnFleetProps.getRuntimeConfiguration()runtimeConfiguration - Instructions for launching server processes on each instance in the fleet.
Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.
This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
this@Stability(value=Stable) public CfnFleetProps.Builder runtimeConfiguration(IResolvable runtimeConfiguration)
CfnFleetProps.getRuntimeConfiguration()runtimeConfiguration - Instructions for launching server processes on each instance in the fleet.
Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception.
This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work.
this@Stability(value=Stable) public CfnFleetProps.Builder scriptId(String scriptId)
CfnFleetProps.getScriptId()scriptId - A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet.
The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId . Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId . Alternatively, enter a ScriptId string manually.
this@Stability(value=Stable) public CfnFleetProps build()
build in interface software.amazon.jsii.Builder<CfnFleetProps>CfnFleetPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.