Interface CfnFleetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFleetProps.Jsii$Proxy
CfnFleet
.
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.*; CfnFleetProps cfnFleetProps = CfnFleetProps.builder() .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() .desiredEc2Instances(123) .maxSize(123) .minSize(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") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFleetProps
static final class
An implementation forCfnFleetProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFleetProps.Builder
builder()
default Object
Amazon GameLift Anywhere configuration options.default String
Current resource capacity settings in a specified fleet or location.default String
A unique identifier for a build to be deployed on the new fleet.default Object
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.default String
The type of compute resource used to host your game servers.default String
A description for the fleet.default Number
The number of EC2 instances that you want this fleet to host.default Object
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.default String
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.default String
Indicates whether to use On-Demand or Spot instances for this fleet.default String
A unique identifier for an IAM role with access permissions to other AWS services.default String
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.default Object
A set of remote locations to deploy additional instances to and manage as part of the fleet.Deprecated.this property has been deprecateddefault Number
The maximum number of instances that are allowed in the specified fleet location.The name of an AWS CloudWatch metric group to add this fleet to.default Number
The minimum number of instances that are allowed in the specified fleet location.getName()
A descriptive label that is associated with a fleet.default String
The status of termination protection for active game sessions on the fleet.default String
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.default String
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.default Object
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.default Object
Instructions for how to launch and maintain server processes on instances in the fleet.default Object
Rule that controls how a fleet is scaled.default String
The unique identifier for a Realtime configuration script to be deployed on fleet instances.default String
Deprecated.this property has been deprecateddefault String
Deprecated.this property has been deprecatedMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
A descriptive label that is associated with a fleet.Fleet names do not need to be unique.
- See Also:
-
getAnywhereConfiguration
Amazon GameLift Anywhere configuration options.- See Also:
-
getApplyCapacity
Current resource capacity settings in a specified fleet or location.The location value might refer to a fleet's remote location or its home Region.
Related actions
DescribeFleetCapacity | DescribeFleetLocationCapacity | UpdateFleetCapacity
- See Also:
-
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.- See Also:
-
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
isDISABLED
. 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 .
- See Also:
-
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. By default, this property is set to
EC2
.- See Also:
-
getDescription
A description for the fleet.- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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 fleet property can't be changed after the fleet is created.- See Also:
-
getInstanceRoleArn
A unique identifier for an IAM role with access permissions to other AWS services.Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other AWS resources from your fleets .
- See Also:
-
getInstanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other AWS resources from your fleets .
- See Also:
-
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.
- See Also:
-
getLogPaths
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used.When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
- See Also:
-
getMaxSize
The maximum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 1.
- See Also:
-
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.
- See Also:
-
getMinSize
The minimum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 0.
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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 .
- See Also:
-
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.- See Also:
-
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 parametersServerLaunchPath
andServerLaunchParameters
, which are still supported for backward compatibility.- See Also:
-
getScalingPolicies
Rule that controls how a fleet is scaled.Scaling policies are uniquely identified by the combination of name and fleet ID.
- See Also:
-
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 propertyScriptId
. Instead, useFn::GetAtt Script.Arn
orFn::GetAtt Script.Id
to retrieve either of these properties as input forScriptId
. Alternatively, enter aScriptId
string manually.- See Also:
-
getServerLaunchParameters
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used but is retained for backward compatibility.Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
- See Also:
-
getServerLaunchPath
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used.Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
- See Also:
-
builder
- Returns:
- a
CfnFleetProps.Builder
ofCfnFleetProps
-