Package software.amazon.awscdk.services.gamelift

Class CfnFleet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnFleet
All Implemented Interfaces:
IInspectable, IFleetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.330Z") @Stability(Stable) public class CfnFleet extends CfnResource implements IInspectable, IFleetRef, ITaggableV2
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())
         .applyCapacity("applyCapacity")
         .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")
         .instanceRoleCredentialsProvider("instanceRoleCredentialsProvider")
         .locations(List.of(LocationConfigurationProperty.builder()
                 .location("location")
                 // the properties below are optional
                 .locationCapacity(LocationCapacityProperty.builder()
                         .maxSize(123)
                         .minSize(123)
                         // the properties below are optional
                         .desiredEc2Instances(123)
                         .build())
                 .build()))
         .logPaths(List.of("logPaths"))
         .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())
         .scalingPolicies(List.of(ScalingPolicyProperty.builder()
                 .metricName("metricName")
                 .name("name")
                 // the properties below are optional
                 .comparisonOperator("comparisonOperator")
                 .evaluationPeriods(123)
                 .location("location")
                 .policyType("policyType")
                 .scalingAdjustment(123)
                 .scalingAdjustmentType("scalingAdjustmentType")
                 .status("status")
                 .targetConfiguration(TargetConfigurationProperty.builder()
                         .targetValue(123)
                         .build())
                 .threshold(123)
                 .updateStatus("updateStatus")
                 .build()))
         .scriptId("scriptId")
         .serverLaunchParameters("serverLaunchParameters")
         .serverLaunchPath("serverLaunchPath")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForFleet

      @Stability(Stable) @NotNull public static String arnForFleet(@NotNull IFleetRef resource)
      Parameters:
      resource - This parameter is required.

    • fromFleetArn

      @Stability(Stable) @NotNull public static IFleetRef fromFleetArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IFleetRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromFleetId

      @Stability(Stable) @NotNull public static IFleetRef fromFleetId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String fleetId)
      Creates a new IFleetRef from a fleetId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      fleetId - This parameter is required.

    • isCfnFleet

      @Stability(Stable) @NotNull public static Boolean isCfnFleet(@NotNull Object x)
      Checks whether the given object is a CfnFleet.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrFleetArn

      @Stability(Stable) @NotNull public String getAttrFleetArn()
      The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.

    • getAttrFleetId

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getFleetRef

      @Stability(Stable) @NotNull public FleetReference getFleetRef()
      A reference to a Fleet resource.
      Specified by:
      getFleetRef in interface IFleetRef

    • getName

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

    • setName

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

    • getAnywhereConfiguration

      @Stability(Stable) @Nullable public Object getAnywhereConfiguration()
      Amazon GameLift Servers Anywhere configuration options.

      Returns union: either IResolvable or CfnFleet.AnywhereConfigurationProperty

    • setAnywhereConfiguration

      @Stability(Stable) public void setAnywhereConfiguration(@Nullable IResolvable value)
      Amazon GameLift Servers Anywhere configuration options.

    • setAnywhereConfiguration

      @Stability(Stable) public void setAnywhereConfiguration(@Nullable CfnFleet.AnywhereConfigurationProperty value)
      Amazon GameLift Servers Anywhere configuration options.

    • getApplyCapacity

      @Stability(Stable) @Nullable public String getApplyCapacity()
      Current resource capacity settings for managed EC2 fleets and managed container fleets.

    • setApplyCapacity

      @Stability(Stable) public void setApplyCapacity(@Nullable String value)
      Current resource capacity settings for managed EC2 fleets and managed container fleets.

    • getBuildId

      @Stability(Stable) @Nullable public String getBuildId()
      A unique identifier for a build to be deployed on the new fleet.

    • setBuildId

      @Stability(Stable) public void setBuildId(@Nullable String value)
      A unique identifier for a build to be deployed on the new fleet.

    • getCertificateConfiguration

      @Stability(Stable) @Nullable public Object getCertificateConfiguration()
      Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

      Returns union: either IResolvable or CfnFleet.CertificateConfigurationProperty

    • setCertificateConfiguration

      @Stability(Stable) public void setCertificateConfiguration(@Nullable IResolvable value)
      Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

    • setCertificateConfiguration

      @Stability(Stable) public void setCertificateConfiguration(@Nullable CfnFleet.CertificateConfigurationProperty value)
      Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

    • getComputeType

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

    • setComputeType

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

    • 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(Deprecated) @Deprecated @Nullable public Number getDesiredEc2Instances()
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The number of EC2 instances that you want this fleet to host.

    • setDesiredEc2Instances

      @Stability(Deprecated) @Deprecated public void setDesiredEc2Instances(@Nullable Number value)
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The number of EC2 instances that you want this fleet to host.

    • getEc2InboundPermissions

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

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFleet.IpPermissionProperty>

    • setEc2InboundPermissions

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

    • setEc2InboundPermissions

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

    • getEc2InstanceType

      @Stability(Stable) @Nullable public String getEc2InstanceType()
      The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.

    • setEc2InstanceType

      @Stability(Stable) public void setEc2InstanceType(@Nullable String value)
      The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.

    • getFleetType

      @Stability(Stable) @Nullable public String getFleetType()
      Indicates whether to use On-Demand or Spot instances for this fleet.

    • setFleetType

      @Stability(Stable) public void setFleetType(@Nullable String value)
      Indicates whether to use On-Demand or Spot instances for this fleet.

    • getInstanceRoleArn

      @Stability(Stable) @Nullable public String getInstanceRoleArn()
      A unique identifier for an IAM role that manages access to your AWS services.

    • setInstanceRoleArn

      @Stability(Stable) public void setInstanceRoleArn(@Nullable String value)
      A unique identifier for an IAM role that manages access to your AWS services.

    • getInstanceRoleCredentialsProvider

      @Stability(Stable) @Nullable public String getInstanceRoleCredentialsProvider()
      Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

    • setInstanceRoleCredentialsProvider

      @Stability(Stable) public void setInstanceRoleCredentialsProvider(@Nullable String value)
      Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

    • getLocations

      @Stability(Stable) @Nullable public Object getLocations()
      A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFleet.LocationConfigurationProperty>

    • setLocations

      @Stability(Stable) public void setLocations(@Nullable IResolvable value)
      A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

    • setLocations

      @Stability(Stable) public void setLocations(@Nullable List<Object> value)
      A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

    • getLogPaths

      @Stability(Deprecated) @Deprecated @Nullable public List<String> getLogPaths()
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used.

    • setLogPaths

      @Stability(Deprecated) @Deprecated public void setLogPaths(@Nullable List<String> value)
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used.

    • getMaxSize

      @Stability(Deprecated) @Deprecated @Nullable public Number getMaxSize()
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.

    • setMaxSize

      @Stability(Deprecated) @Deprecated public void setMaxSize(@Nullable Number value)
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.

    • getMetricGroups

      @Stability(Stable) @Nullable public List<String> getMetricGroups()
      The name of an AWS CloudWatch metric group to add this fleet to.

    • setMetricGroups

      @Stability(Stable) public void setMetricGroups(@Nullable List<String> value)
      The name of an AWS CloudWatch metric group to add this fleet to.

    • getMinSize

      @Stability(Deprecated) @Deprecated @Nullable public Number getMinSize()
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.

    • setMinSize

      @Stability(Deprecated) @Deprecated public void setMinSize(@Nullable Number value)
      Deprecated.
      this property has been deprecated
      (deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.

    • getNewGameSessionProtectionPolicy

      @Stability(Stable) @Nullable public String getNewGameSessionProtectionPolicy()
      The status of termination protection for active game sessions on the fleet.

    • setNewGameSessionProtectionPolicy

      @Stability(Stable) public void setNewGameSessionProtectionPolicy(@Nullable String value)
      The status of termination protection for active game sessions on the fleet.

    • getPeerVpcAwsAccountId

      @Stability(Stable) @Nullable public String getPeerVpcAwsAccountId()
      Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

    • setPeerVpcAwsAccountId

      @Stability(Stable) public void setPeerVpcAwsAccountId(@Nullable String value)
      Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

    • getPeerVpcId

      @Stability(Stable) @Nullable public String getPeerVpcId()
      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.

    • setPeerVpcId

      @Stability(Stable) public void setPeerVpcId(@Nullable String value)
      A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.

    • 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.

      Returns union: either IResolvable or CfnFleet.ResourceCreationLimitPolicyProperty

    • 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.

      Returns union: either IResolvable or CfnFleet.RuntimeConfigurationProperty

    • setRuntimeConfiguration

      @Stability(Stable) public void setRuntimeConfiguration(@Nullable IResolvable value)
      Instructions for how to launch and maintain server processes on instances in the fleet.

    • setRuntimeConfiguration

      @Stability(Stable) public void setRuntimeConfiguration(@Nullable CfnFleet.RuntimeConfigurationProperty value)
      Instructions for how to launch and maintain server processes on instances in the fleet.

    • getScalingPolicies

      @Stability(Stable) @Nullable public Object getScalingPolicies()
      Rule that controls how a fleet is scaled.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFleet.ScalingPolicyProperty>

    • setScalingPolicies

      @Stability(Stable) public void setScalingPolicies(@Nullable IResolvable value)
      Rule that controls how a fleet is scaled.

    • setScalingPolicies

      @Stability(Stable) public void setScalingPolicies(@Nullable List<Object> value)
      Rule that controls how a fleet is scaled.

    • getScriptId

      @Stability(Stable) @Nullable public String getScriptId()
      The unique identifier for a Realtime configuration script to be deployed on fleet instances.

    • setScriptId

      @Stability(Stable) public void setScriptId(@Nullable String value)
      The unique identifier for a Realtime configuration script to be deployed on fleet instances.

    • getServerLaunchParameters

      @Stability(Deprecated) @Deprecated @Nullable public String getServerLaunchParameters()
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used but is retained for backward compatibility.

    • setServerLaunchParameters

      @Stability(Deprecated) @Deprecated public void setServerLaunchParameters(@Nullable String value)
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used but is retained for backward compatibility.

    • getServerLaunchPath

      @Stability(Deprecated) @Deprecated @Nullable public String getServerLaunchPath()
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used.

    • setServerLaunchPath

      @Stability(Deprecated) @Deprecated public void setServerLaunchPath(@Nullable String value)
      Deprecated.
      this property has been deprecated
      (deprecated) This parameter is no longer used.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.