Package software.amazon.awscdk.services.gamelift

Class CfnFleet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.gamelift.CfnFleet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.858Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable
A CloudFormation AWS::GameLift::Fleet.

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers. A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFleet

      protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFleet

      @Stability(Stable) public CfnFleet(@NotNull Construct scope, @NotNull String id, @NotNull CfnFleetProps props)
      Create a new AWS::GameLift::Fleet.

      Parameters:
      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.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrFleetId

      @Stability(Stable) @NotNull public String getAttrFleetId()
      A unique identifier for the fleet.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      A descriptive label that is associated with a fleet.

      Fleet names do not need to be unique.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive label that is associated with a fleet.

      Fleet names do not need to be unique.

    • getAnywhereConfiguration

      @Stability(Stable) @Nullable public Object getAnywhereConfiguration()
      AWS::GameLift::Fleet.AnywhereConfiguration.

    • setAnywhereConfiguration

      @Stability(Stable) public void setAnywhereConfiguration(@Nullable IResolvable value)
      AWS::GameLift::Fleet.AnywhereConfiguration.

    • setAnywhereConfiguration

      @Stability(Stable) public void setAnywhereConfiguration(@Nullable CfnFleet.AnywhereConfigurationProperty value)
      AWS::GameLift::Fleet.AnywhereConfiguration.

    • getBuildId

      @Stability(Stable) @Nullable public String getBuildId()
      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.

    • setBuildId

      @Stability(Stable) public void setBuildId(@Nullable String value)
      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.

    • getCertificateConfiguration

      @Stability(Stable) @Nullable public Object getCertificateConfiguration()
      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 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 .

    • setCertificateConfiguration

      @Stability(Stable) public void setCertificateConfiguration(@Nullable IResolvable value)
      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 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 .

    • setCertificateConfiguration

      @Stability(Stable) public void setCertificateConfiguration(@Nullable CfnFleet.CertificateConfigurationProperty value)
      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 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 .

    • getComputeType

      @Stability(Stable) @Nullable public String getComputeType()
      The type of compute resource used to host your game servers.

      You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

    • setComputeType

      @Stability(Stable) public void setComputeType(@Nullable String value)
      The type of compute resource used to host your game servers.

      You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the fleet.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the fleet.

    • getDesiredEc2Instances

      @Stability(Stable) @Nullable public Number getDesiredEc2Instances()
      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.

    • setDesiredEc2Instances

      @Stability(Stable) public void setDesiredEc2Instances(@Nullable Number value)
      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.

    • getEc2InboundPermissions

      @Stability(Stable) @Nullable public Object getEc2InboundPermissions()
      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      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, Amazon GameLift automatically sets TCP and UDP ranges.

    • setEc2InboundPermissions

      @Stability(Stable) public void setEc2InboundPermissions(@Nullable IResolvable value)
      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      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, Amazon GameLift automatically sets TCP and UDP ranges.

    • setEc2InboundPermissions

      @Stability(Stable) public void setEc2InboundPermissions(@Nullable List<Object> value)
      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.

      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, Amazon GameLift automatically sets TCP and UDP ranges.

    • getEc2InstanceType

      @Stability(Stable) @Nullable public String getEc2InstanceType()
      The Amazon 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.

    • setEc2InstanceType

      @Stability(Stable) public void setEc2InstanceType(@Nullable String value)
      The Amazon 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.

    • getFleetType

      @Stability(Stable) @Nullable public String getFleetType()
      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.

    • setFleetType

      @Stability(Stable) public void setFleetType(@Nullable String value)
      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.

    • getInstanceRoleArn

      @Stability(Stable) @Nullable public String getInstanceRoleArn()
      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.

    • setInstanceRoleArn

      @Stability(Stable) public void setInstanceRoleArn(@Nullable String value)
      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.

    • getLocations

      @Stability(Stable) @Nullable public Object getLocations()
      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 Amazon 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, don't use this parameter.

      To use this parameter, Amazon GameLift requires you to use your home location in the request.

    • setLocations

      @Stability(Stable) public void setLocations(@Nullable IResolvable value)
      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 Amazon 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, don't use this parameter.

      To use this parameter, Amazon GameLift requires you to use your home location in the request.

    • setLocations

      @Stability(Stable) public void setLocations(@Nullable List<Object> value)
      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 Amazon 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, don't use this parameter.

      To use this parameter, Amazon GameLift requires you to use your home location in the request.

    • getMaxSize

      @Stability(Stable) @Nullable public Number getMaxSize()
      The maximum number of instances that are allowed in the specified fleet location.

      If this parameter is not set, the default is 1.

    • setMaxSize

      @Stability(Stable) public void setMaxSize(@Nullable Number value)
      The maximum number of instances that are allowed in the specified fleet location.

      If this parameter is not set, the default is 1.

    • getMetricGroups

      @Stability(Stable) @Nullable public List<String> getMetricGroups()
      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.

    • setMetricGroups

      @Stability(Stable) public void setMetricGroups(@Nullable List<String> value)
      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.

    • getMinSize

      @Stability(Stable) @Nullable public Number getMinSize()
      The minimum number of instances that are allowed in the specified fleet location.

      If this parameter is not set, the default is 0.

    • setMinSize

      @Stability(Stable) public void setMinSize(@Nullable Number value)
      The minimum number of instances that are allowed in the specified fleet location.

      If this parameter is not set, the default is 0.

    • getNewGameSessionProtectionPolicy

      @Stability(Stable) @Nullable public String getNewGameSessionProtectionPolicy()
      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.

    • setNewGameSessionProtectionPolicy

      @Stability(Stable) public void setNewGameSessionProtectionPolicy(@Nullable String value)
      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.

    • getPeerVpcAwsAccountId

      @Stability(Stable) @Nullable public String getPeerVpcAwsAccountId()
      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.

    • setPeerVpcAwsAccountId

      @Stability(Stable) public void setPeerVpcAwsAccountId(@Nullable String value)
      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.

    • getPeerVpcId

      @Stability(Stable) @Nullable public String getPeerVpcId()
      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 .

    • setPeerVpcId

      @Stability(Stable) public void setPeerVpcId(@Nullable String value)
      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 .

    • getResourceCreationLimitPolicy

      @Stability(Stable) @Nullable public 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.

    • setResourceCreationLimitPolicy

      @Stability(Stable) public void setResourceCreationLimitPolicy(@Nullable 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.

    • setResourceCreationLimitPolicy

      @Stability(Stable) public void setResourceCreationLimitPolicy(@Nullable 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.

    • getRuntimeConfiguration

      @Stability(Stable) @Nullable public Object getRuntimeConfiguration()
      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 parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

    • setRuntimeConfiguration

      @Stability(Stable) public void setRuntimeConfiguration(@Nullable IResolvable value)
      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 parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

    • setRuntimeConfiguration

      @Stability(Stable) public void setRuntimeConfiguration(@Nullable CfnFleet.RuntimeConfigurationProperty value)
      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 parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

    • getScriptId

      @Stability(Stable) @Nullable public String getScriptId()
      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 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.

    • setScriptId

      @Stability(Stable) public void setScriptId(@Nullable String value)
      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 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.