@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:46.477Z") public class CfnFleet extends CfnResource implements IInspectable
The AWS::GameLift::Fleet
resource creates an Amazon GameLift (GameLift) fleet to host game servers. A fleet is a set of EC2 instances, each of which can host multiple game sessions.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.gamelift.*; CfnFleet cfnFleet = CfnFleet.Builder.create(this, "MyCfnFleet") .name("name") // the properties below are optional .anywhereConfiguration(AnywhereConfigurationProperty.builder() .cost("cost") .build()) .buildId("buildId") .certificateConfiguration(CertificateConfigurationProperty.builder() .certificateType("certificateType") .build()) .computeType("computeType") .description("description") .desiredEc2Instances(123) .ec2InboundPermissions(List.of(IpPermissionProperty.builder() .fromPort(123) .ipRange("ipRange") .protocol("protocol") .toPort(123) .build())) .ec2InstanceType("ec2InstanceType") .fleetType("fleetType") .instanceRoleArn("instanceRoleArn") .locations(List.of(LocationConfigurationProperty.builder() .location("location") // the properties below are optional .locationCapacity(LocationCapacityProperty.builder() .desiredEc2Instances(123) .maxSize(123) .minSize(123) .build()) .build())) .maxSize(123) .metricGroups(List.of("metricGroups")) .minSize(123) .newGameSessionProtectionPolicy("newGameSessionProtectionPolicy") .peerVpcAwsAccountId("peerVpcAwsAccountId") .peerVpcId("peerVpcId") .resourceCreationLimitPolicy(ResourceCreationLimitPolicyProperty.builder() .newGameSessionsPerCreator(123) .policyPeriodInMinutes(123) .build()) .runtimeConfiguration(RuntimeConfigurationProperty.builder() .gameSessionActivationTimeoutSeconds(123) .maxConcurrentGameSessionActivations(123) .serverProcesses(List.of(ServerProcessProperty.builder() .concurrentExecutions(123) .launchPath("launchPath") // the properties below are optional .parameters("parameters") .build())) .build()) .scriptId("scriptId") .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnFleet.AnywhereConfigurationProperty
GameLift Anywhere configuration options for your Anywhere fleets.
|
static class |
CfnFleet.Builder
A fluent builder for
CfnFleet . |
static interface |
CfnFleet.CertificateConfigurationProperty
Determines whether a TLS/SSL certificate is generated for a fleet.
|
static interface |
CfnFleet.IpPermissionProperty
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet.
|
static interface |
CfnFleet.LocationCapacityProperty
Current resource capacity settings in a specified fleet or location.
|
static interface |
CfnFleet.LocationConfigurationProperty
A remote location where a multi-location fleet can deploy EC2 instances for game hosting.
|
static interface |
CfnFleet.ResourceCreationLimitPolicyProperty
A policy that limits the number of game sessions a player can create on the same fleet.
|
static interface |
CfnFleet.RuntimeConfigurationProperty
A collection of server process configurations that describe the set of processes to run on each instance in a fleet.
|
static interface |
CfnFleet.ServerProcessProperty
A set of instructions for launching server processes on each instance in a fleet.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnFleet(Construct scope,
java.lang.String id,
CfnFleetProps props)
Create a new `AWS::GameLift::Fleet`.
|
protected |
CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnFleet(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAnywhereConfiguration()
`AWS::GameLift::Fleet.AnywhereConfiguration`.
|
java.lang.String |
getAttrFleetId()
A unique identifier for the fleet.
|
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.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getComputeType()
The type of compute resource used to host your game servers.
|
java.lang.String |
getDescription()
A description for 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.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAnywhereConfiguration(CfnFleet.AnywhereConfigurationProperty value)
`AWS::GameLift::Fleet.AnywhereConfiguration`.
|
void |
setAnywhereConfiguration(IResolvable value)
`AWS::GameLift::Fleet.AnywhereConfiguration`.
|
void |
setBuildId(java.lang.String value)
A unique identifier for a build to be deployed on the new fleet.
|
void |
setCertificateConfiguration(CfnFleet.CertificateConfigurationProperty value)
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
void |
setCertificateConfiguration(IResolvable value)
Prompts GameLift to generate a TLS/SSL certificate for the fleet.
|
void |
setComputeType(java.lang.String value)
The type of compute resource used to host your game servers.
|
void |
setDescription(java.lang.String value)
A description for the fleet.
|
void |
setDesiredEc2Instances(java.lang.Number value)
The number of EC2 instances that you want this fleet to host.
|
void |
setEc2InboundPermissions(IResolvable value)
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
void |
setEc2InboundPermissions(java.util.List<java.lang.Object> value)
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
|
void |
setEc2InstanceType(java.lang.String value)
The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
|
void |
setFleetType(java.lang.String value)
Indicates whether to use On-Demand or Spot instances for this fleet.
|
void |
setInstanceRoleArn(java.lang.String value)
A unique identifier for an IAM role that manages access to your AWS services.
|
void |
setLocations(IResolvable value)
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
void |
setLocations(java.util.List<java.lang.Object> value)
A set of remote locations to deploy additional instances to and manage as part of the fleet.
|
void |
setMaxSize(java.lang.Number value)
The maximum number of instances that are allowed in the specified fleet location.
|
void |
setMetricGroups(java.util.List<java.lang.String> value)
The name of an AWS CloudWatch metric group to add this fleet to.
|
void |
setMinSize(java.lang.Number value)
The minimum number of instances that are allowed in the specified fleet location.
|
void |
setName(java.lang.String value)
A descriptive label that is associated with a fleet.
|
void |
setNewGameSessionProtectionPolicy(java.lang.String value)
The status of termination protection for active game sessions on the fleet.
|
void |
setPeerVpcAwsAccountId(java.lang.String value)
Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
|
void |
setPeerVpcId(java.lang.String value)
A unique identifier for a VPC with resources to be accessed by your GameLift fleet.
|
void |
setResourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty value)
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.
|
void |
setResourceCreationLimitPolicy(IResolvable value)
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.
|
void |
setRuntimeConfiguration(CfnFleet.RuntimeConfigurationProperty value)
Instructions for how to launch and maintain server processes on instances in the fleet.
|
void |
setRuntimeConfiguration(IResolvable value)
Instructions for how to launch and maintain server processes on instances in the fleet.
|
void |
setScriptId(java.lang.String value)
The unique identifier for a Realtime configuration script to be deployed on fleet instances.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFleet(Construct scope, java.lang.String id, CfnFleetProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrFleetId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
Fleet names do not need to be unique.
public void setName(java.lang.String value)
Fleet names do not need to be unique.
public java.lang.Object getAnywhereConfiguration()
public void setAnywhereConfiguration(IResolvable value)
public void setAnywhereConfiguration(CfnFleet.AnywhereConfigurationProperty value)
public java.lang.String getBuildId()
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.
public void setBuildId(java.lang.String value)
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.
public java.lang.Object getCertificateConfiguration()
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 .
public void setCertificateConfiguration(IResolvable value)
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 .
public void setCertificateConfiguration(CfnFleet.CertificateConfigurationProperty value)
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 .
public java.lang.String getComputeType()
You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
public void setComputeType(java.lang.String value)
You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Number getDesiredEc2Instances()
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.
public void setDesiredEc2Instances(java.lang.Number value)
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.
public java.lang.Object getEc2InboundPermissions()
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.
public void setEc2InboundPermissions(IResolvable value)
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.
public void setEc2InboundPermissions(java.util.List<java.lang.Object> value)
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.
public java.lang.String getEc2InstanceType()
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.
public void setEc2InstanceType(java.lang.String value)
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.
public java.lang.String getFleetType()
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.
public void setFleetType(java.lang.String value)
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.
public java.lang.String getInstanceRoleArn()
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.
public void setInstanceRoleArn(java.lang.String value)
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.
public java.lang.Object getLocations()
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.
public void setLocations(IResolvable value)
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.
public void setLocations(java.util.List<java.lang.Object> value)
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.
public java.lang.Number getMaxSize()
If this parameter is not set, the default is 1.
public void setMaxSize(java.lang.Number value)
If this parameter is not set, the default is 1.
public java.util.List<java.lang.String> getMetricGroups()
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.
public void setMetricGroups(java.util.List<java.lang.String> value)
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.
public java.lang.Number getMinSize()
If this parameter is not set, the default is 0.
public void setMinSize(java.lang.Number value)
If this parameter is not set, the default is 0.
public java.lang.String getNewGameSessionProtectionPolicy()
By default, this property is set to NoProtection
.
ACTIVE
status cannot be terminated during a scale-down event.public void setNewGameSessionProtectionPolicy(java.lang.String value)
By default, this property is set to NoProtection
.
ACTIVE
status cannot be terminated during a scale-down event.public java.lang.String getPeerVpcAwsAccountId()
You can find your account ID in the AWS Management Console under account settings.
public void setPeerVpcAwsAccountId(java.lang.String value)
You can find your account ID in the AWS Management Console under account settings.
public java.lang.String getPeerVpcId()
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 .
public void setPeerVpcId(java.lang.String value)
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 .
public java.lang.Object getResourceCreationLimitPolicy()
public void setResourceCreationLimitPolicy(IResolvable value)
public void setResourceCreationLimitPolicy(CfnFleet.ResourceCreationLimitPolicyProperty value)
public java.lang.Object getRuntimeConfiguration()
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.
public void setRuntimeConfiguration(IResolvable value)
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.
public void setRuntimeConfiguration(CfnFleet.RuntimeConfigurationProperty value)
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.
public java.lang.String getScriptId()
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.
public void setScriptId(java.lang.String value)
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.