@Stability(value=Stable) @Internal public static final class CfnFleetProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnFleetProps
CfnFleetPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnFleetProps.Builder, CfnFleetProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnFleetProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnFleetProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getBuildId()
A unique identifier for a build to be deployed on the new fleet.
|
Object |
getCertificateConfiguration()
Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
String |
getDescription()
A human-readable description of the fleet.
|
Number |
getDesiredEc2Instances()
The number of EC2 instances that you want this fleet to host.
|
Object |
getEc2InboundPermissions()
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
|
String |
getEc2InstanceType()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
String |
getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
getInstanceRoleArn()
A unique identifier for an IAM role that manages access to your AWS services.
|
Object |
getLocations()
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
Number |
getMaxSize()
The maximum value that is allowed for the fleet's instance count.
|
List<String> |
getMetricGroups()
The name of an Amazon CloudWatch metric group.
|
Number |
getMinSize()
The minimum value allowed for the fleet's instance count.
|
String |
getName()
A descriptive label that is associated with a fleet.
|
String |
getNewGameSessionProtectionPolicy()
A game session protection policy to apply to all game sessions hosted on instances in this fleet.
|
String |
getPeerVpcAwsAccountId()
Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
|
String |
getPeerVpcId()
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
Object |
getResourceCreationLimitPolicy()
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.
|
Object |
getRuntimeConfiguration()
Instructions for launching server processes on each instance in the fleet.
|
String |
getScriptId()
A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnFleetProps.Builder builder)
CfnFleetProps.Builder.public final String getBuildId()
CfnFleetProps
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.
getBuildId in interface CfnFleetPropspublic final Object getCertificateConfiguration()
CfnFleetPropsTLS 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.
getCertificateConfiguration in interface CfnFleetPropspublic final String getDescription()
CfnFleetPropsgetDescription in interface CfnFleetPropspublic final Number getDesiredEc2Instances()
CfnFleetPropsWhen 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.
getDesiredEc2Instances in interface CfnFleetPropspublic final Object getEc2InboundPermissions()
CfnFleetPropsgetEc2InboundPermissions in interface CfnFleetPropspublic final String getEc2InstanceType()
CfnFleetPropsInstance 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.
getEc2InstanceType in interface CfnFleetPropspublic final String getFleetType()
CfnFleetProps
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.
getFleetType in interface CfnFleetPropspublic final String getInstanceRoleArn()
CfnFleetPropsWith 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.
getInstanceRoleArn in interface CfnFleetPropspublic final Object getLocations()
CfnFleetProps
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.
getLocations in interface CfnFleetPropspublic final Number getMaxSize()
CfnFleetPropsWhen creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
getMaxSize in interface CfnFleetPropspublic final List<String> getMetricGroups()
CfnFleetPropsA 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.
getMetricGroups in interface CfnFleetPropspublic final Number getMinSize()
CfnFleetPropsWhen creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
getMinSize in interface CfnFleetPropspublic final String getName()
CfnFleetPropsFleet names do not need to be unique.
getName in interface CfnFleetPropspublic final String getNewGameSessionProtectionPolicy()
CfnFleetPropsWhen 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.
getNewGameSessionProtectionPolicy in interface CfnFleetPropspublic final String getPeerVpcAwsAccountId()
CfnFleetPropsYou can find your account ID in the AWS Management Console under account settings.
getPeerVpcAwsAccountId in interface CfnFleetPropspublic final String getPeerVpcId()
CfnFleetPropsThe 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 .
getPeerVpcId in interface CfnFleetPropspublic final Object getResourceCreationLimitPolicy()
CfnFleetPropsgetResourceCreationLimitPolicy in interface CfnFleetPropspublic final Object getRuntimeConfiguration()
CfnFleetPropsServer 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.
getRuntimeConfiguration in interface CfnFleetPropspublic final String getScriptId()
CfnFleetPropsThe 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.
getScriptId in interface CfnFleetProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.