public static final class CfnFleetProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnFleetProps
CfnFleetProps
CfnFleetProps.Builder, CfnFleetProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
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(java.lang.Object o) |
java.lang.String |
getBuildId()
A unique identifier for a build to be deployed on the new fleet.
|
java.lang.Object |
getCertificateConfiguration()
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
java.lang.String |
getDescription()
A human-readable description of the fleet.
|
java.lang.Number |
getDesiredEc2Instances()
The number of EC2 instances that you want this fleet to host.
|
java.lang.Object |
getEc2InboundPermissions()
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
java.lang.String |
getEc2InstanceType()
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
java.lang.String |
getFleetType()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
java.lang.String |
getInstanceRoleArn()
A unique identifier for an IAM role that manages access to your AWS services.
|
java.lang.Object |
getLocations()
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
java.lang.Number |
getMaxSize()
The maximum number of instances that are allowed in the specified fleet location.
|
java.util.List<java.lang.String> |
getMetricGroups()
The name of an AWS CloudWatch metric group to add this fleet to.
|
java.lang.Number |
getMinSize()
The minimum number of instances that are allowed in the specified fleet location.
|
java.lang.String |
getName()
A descriptive label that is associated with a fleet.
|
java.lang.String |
getNewGameSessionProtectionPolicy()
The status of termination protection for active game sessions on the fleet.
|
java.lang.String |
getPeerVpcAwsAccountId()
Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
|
java.lang.String |
getPeerVpcId()
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
java.lang.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.
|
java.lang.Object |
getRuntimeConfiguration()
Instructions for how to launch and maintain server processes on instances in the fleet.
|
java.lang.String |
getScriptId()
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.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 CfnFleetProps
public final java.lang.Object getCertificateConfiguration()
CfnFleetProps
GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift. By default, the CertificateConfiguration
is DISABLED
. 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 .
getCertificateConfiguration
in interface CfnFleetProps
public final java.lang.String getDescription()
CfnFleetProps
getDescription
in interface CfnFleetProps
public final java.lang.Number getDesiredEc2Instances()
CfnFleetProps
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.
getDesiredEc2Instances
in interface CfnFleetProps
public final java.lang.Object getEc2InboundPermissions()
CfnFleetProps
If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.
getEc2InboundPermissions
in interface CfnFleetProps
public final java.lang.String getEc2InstanceType()
CfnFleetProps
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.
getEc2InstanceType
in interface CfnFleetProps
public final java.lang.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 CfnFleetProps
public final java.lang.String getInstanceRoleArn()
CfnFleetProps
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.
getInstanceRoleArn
in interface CfnFleetProps
public final java.lang.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 CfnFleetProps
public final java.lang.Number getMaxSize()
CfnFleetProps
If this parameter is not set, the default is 1.
getMaxSize
in interface CfnFleetProps
public final java.util.List<java.lang.String> getMetricGroups()
CfnFleetProps
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.
getMetricGroups
in interface CfnFleetProps
public final java.lang.Number getMinSize()
CfnFleetProps
If this parameter is not set, the default is 0.
getMinSize
in interface CfnFleetProps
public final java.lang.String getName()
CfnFleetProps
Fleet names do not need to be unique.
getName
in interface CfnFleetProps
public final java.lang.String getNewGameSessionProtectionPolicy()
CfnFleetProps
By default, this property is set to NoProtection
.
ACTIVE
status cannot be terminated during a scale-down event.getNewGameSessionProtectionPolicy
in interface CfnFleetProps
public final java.lang.String getPeerVpcAwsAccountId()
CfnFleetProps
You can find your account ID in the AWS Management Console under account settings.
getPeerVpcAwsAccountId
in interface CfnFleetProps
public final java.lang.String getPeerVpcId()
CfnFleetProps
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 .
getPeerVpcId
in interface CfnFleetProps
public final java.lang.Object getResourceCreationLimitPolicy()
CfnFleetProps
getResourceCreationLimitPolicy
in interface CfnFleetProps
public final java.lang.Object getRuntimeConfiguration()
CfnFleetProps
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.
getRuntimeConfiguration
in interface CfnFleetProps
public final java.lang.String getScriptId()
CfnFleetProps
You can use either the script ID or ARN. Scripts must be uploaded to 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.
getScriptId
in interface CfnFleetProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()