CfnFleet (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.463Z")
 @Stability(value=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 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")
         .buildId("buildId")
         .certificateConfiguration(CertificateConfigurationProperty.builder()
                 .certificateType("certificateType")
                 .build())
         .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)
         .name("name")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnFleet(software.constructs.Construct scope, String id)` Create a new `AWS::GameLift::Fleet`.
	`CfnFleet(software.constructs.Construct scope, 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)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrFleetId()` A unique identifier for the fleet.
`String`	`getBuildId()` A unique identifier for a build to be deployed on the new fleet.
`Object`	`getCertificateConfiguration()` Prompts GameLift to generate a TLS/SSL certificate for the fleet.
`protected Map<String,Object>`	`getCfnProperties()`
`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()` The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
`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 number of instances that are allowed in the specified fleet location.
`List<String>`	`getMetricGroups()` The name of an AWS CloudWatch metric group to add this fleet to.
`Number`	`getMinSize()` The minimum number of instances that are allowed in the specified fleet location.
`String`	`getName()` A descriptive label that is associated with a fleet.
`String`	`getNewGameSessionProtectionPolicy()` The status of termination protection for active game sessions on the 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 how to launch and maintain server processes on instances in the fleet.
`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 Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setBuildId(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`	`setDescription(String value)` A human-readable description of the fleet.
`void`	`setDesiredEc2Instances(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(List<Object> value)` The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
`void`	`setEc2InstanceType(String value)` The GameLift-supported Amazon EC2 instance type to use for all fleet instances.
`void`	`setFleetType(String value)` Indicates whether to use On-Demand or Spot instances for this fleet.
`void`	`setInstanceRoleArn(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(List<Object> value)` A set of remote locations to deploy additional instances to and manage as part of the fleet.
`void`	`setMaxSize(Number value)` The maximum number of instances that are allowed in the specified fleet location.
`void`	`setMetricGroups(List<String> value)` The name of an AWS CloudWatch metric group to add this fleet to.
`void`	`setMinSize(Number value)` The minimum number of instances that are allowed in the specified fleet location.
`void`	`setName(String value)` A descriptive label that is associated with a fleet.
`void`	`setNewGameSessionProtectionPolicy(String value)` The status of termination protection for active game sessions on the fleet.
`void`	`setPeerVpcAwsAccountId(String value)` Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
`void`	`setPeerVpcId(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(String value)` The unique identifier for a Realtime configuration script to be deployed on fleet instances.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnFleet
```
protected CfnFleet(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnFleet
```
protected CfnFleet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnFleet
```
@Stability(value=Stable)
public CfnFleet(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @Nullable
                                         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.
  - CfnFleet
```
@Stability(value=Stable)
public CfnFleet(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id)
```
    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.
- Method Detail
  - inspect
```
@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrFleetId()
```
    A unique identifier for the fleet.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getBuildId
```
@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getCertificateConfiguration()
```
    Prompts GameLift to generate a TLS/SSL certificate for the fleet.
    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 .
  - setCertificateConfiguration
```
@Stability(value=Stable)
public void setCertificateConfiguration(@Nullable
                                                                 CfnFleet.CertificateConfigurationProperty value)
```
    Prompts GameLift to generate a TLS/SSL certificate for the fleet.
    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 .
  - setCertificateConfiguration
```
@Stability(value=Stable)
public void setCertificateConfiguration(@Nullable
                                                                 IResolvable value)
```
    Prompts GameLift to generate a TLS/SSL certificate for the fleet.
    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 .
  - getDescription
```
@Stability(value=Stable)
 @Nullable
public String getDescription()
```
    A human-readable description of the fleet.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    A human-readable description of the fleet.
  - getDesiredEc2Instances
```
@Stability(value=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(value=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(value=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, GameLift automatically sets TCP and UDP ranges.
  - setEc2InboundPermissions
```
@Stability(value=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, GameLift automatically sets TCP and UDP ranges.
  - setEc2InboundPermissions
```
@Stability(value=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, GameLift automatically sets TCP and UDP ranges.
  - getEc2InstanceType
```
@Stability(value=Stable)
 @Nullable
public String getEc2InstanceType()
```
    The 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(value=Stable)
public void setEc2InstanceType(@Nullable
                                                        String value)
```
    The 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(value=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(value=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(value=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(value=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(value=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 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.
  - setLocations
```
@Stability(value=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 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.
  - setLocations
```
@Stability(value=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 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.
  - getMaxSize
```
@Stability(value=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(value=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(value=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(value=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(value=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(value=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.
  - getName
```
@Stability(value=Stable)
 @Nullable
public String getName()
```
    A descriptive label that is associated with a fleet.
    Fleet names do not need to be unique.
  - setName
```
@Stability(value=Stable)
public void setName(@Nullable
                                             String value)
```
    A descriptive label that is associated with a fleet.
    Fleet names do not need to be unique.
  - getNewGameSessionProtectionPolicy
```
@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getPeerVpcAwsAccountId()
```
    Used when peering your 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(value=Stable)
public void setPeerVpcAwsAccountId(@Nullable
                                                            String value)
```
    Used when peering your 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(value=Stable)
 @Nullable
public String getPeerVpcId()
```
    A unique identifier for a VPC with resources to be accessed by your 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 GameLift Fleets .
  - setPeerVpcId
```
@Stability(value=Stable)
public void setPeerVpcId(@Nullable
                                                  String value)
```
    A unique identifier for a VPC with resources to be accessed by your 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 GameLift Fleets .
  - getResourceCreationLimitPolicy
```
@Stability(value=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(value=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.
  - setResourceCreationLimitPolicy
```
@Stability(value=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.
  - getRuntimeConfiguration
```
@Stability(value=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(value=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.
  - setRuntimeConfiguration
```
@Stability(value=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.
  - getScriptId
```
@Stability(value=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 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(value=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 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.

Class CfnFleet

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnFleet

CfnFleet

CfnFleet

CfnFleet

Method Detail

inspect

renderProperties

getAttrFleetId

getCfnProperties

getBuildId

setBuildId

getCertificateConfiguration

setCertificateConfiguration

setCertificateConfiguration

getDescription

setDescription

getDesiredEc2Instances

setDesiredEc2Instances

getEc2InboundPermissions

setEc2InboundPermissions

setEc2InboundPermissions

getEc2InstanceType

setEc2InstanceType

getFleetType

setFleetType

getInstanceRoleArn

setInstanceRoleArn

getLocations

setLocations

setLocations

getMaxSize

setMaxSize

getMetricGroups

setMetricGroups

getMinSize

setMinSize

getName

setName

getNewGameSessionProtectionPolicy

setNewGameSessionProtectionPolicy

getPeerVpcAwsAccountId

setPeerVpcAwsAccountId

getPeerVpcId

setPeerVpcId

getResourceCreationLimitPolicy

setResourceCreationLimitPolicy

setResourceCreationLimitPolicy

getRuntimeConfiguration

setRuntimeConfiguration

setRuntimeConfiguration

getScriptId

setScriptId