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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:08.812Z")
@Stability(Stable)
public class CfnFleet
extends CfnResource
implements IInspectable
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() .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 TypeClassDescriptionstatic interface
Amazon GameLift configuration options for your Anywhere fleets.static final class
A fluent builder forCfnFleet
.static interface
Determines whether a TLS/SSL certificate is generated for a fleet.static interface
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
Current resource capacity settings for managed EC2 fleets and managed container fleets.static interface
A remote location where a multi-location fleet can deploy game servers for game hosting.static interface
A policy that limits the number of game sessions a player can create on the same fleet.static interface
A collection of server process configurations that describe the set of processes to run on each instance in a fleet.static interface
Rule that controls how a fleet is scaled.static interface
A set of instructions for launching server processes on each instance in a fleet.static interface
Settings for a target-based scaling policy.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnFleet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnFleet
(software.amazon.jsii.JsiiObjectRef objRef) CfnFleet
(software.constructs.Construct scope, String id, CfnFleetProps props) -
Method Summary
Modifier and TypeMethodDescriptionAmazon GameLift Anywhere configuration options.Current resource capacity settings for managed EC2 fleets and managed container fleets.A unique identifier for the fleet.A unique identifier for a build to be deployed on the new fleet.Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.The type of compute resource used to host your game servers.A description for the fleet.The number of EC2 instances that you want this fleet to host.The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.Indicates whether to use On-Demand or Spot instances for this fleet.A unique identifier for an IAM role that manages access to your AWS services.Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.A set of remote locations to deploy additional instances to and manage as a multi-location fleet.Deprecated.this property has been deprecatedThe 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.The minimum number of instances that are allowed in the specified fleet location.getName()
A descriptive label that is associated with a fleet.The status of termination protection for active game sessions on the fleet.Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.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.Instructions for how to launch and maintain server processes on instances in the fleet.Rule that controls how a fleet is scaled.The unique identifier for a Realtime configuration script to be deployed on fleet instances.Deprecated.this property has been deprecatedDeprecated.this property has been deprecatedvoid
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Amazon GameLift Anywhere configuration options.void
Amazon GameLift Anywhere configuration options.void
setApplyCapacity
(String value) Current resource capacity settings for managed EC2 fleets and managed container fleets.void
setBuildId
(String value) A unique identifier for a build to be deployed on the new fleet.void
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.void
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.void
setComputeType
(String value) The type of compute resource used to host your game servers.void
setDescription
(String value) A description for the fleet.void
setDesiredEc2Instances
(Number value) The number of EC2 instances that you want this fleet to host.void
setEc2InboundPermissions
(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.void
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.void
setEc2InstanceType
(String value) The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets.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
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.void
setLocations
(List<Object> value) A set of remote locations to deploy additional instances to and manage as a multi-location fleet.void
setLocations
(IResolvable value) A set of remote locations to deploy additional instances to and manage as a multi-location fleet.void
setLogPaths
(List<String> value) Deprecated.this property has been deprecatedvoid
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
A descriptive label that is associated with a fleet.void
The status of termination protection for active game sessions on the fleet.void
setPeerVpcAwsAccountId
(String value) Used when peering your Amazon 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 Amazon GameLift fleet.void
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
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
Instructions for how to launch and maintain server processes on instances in the fleet.void
Instructions for how to launch and maintain server processes on instances in the fleet.void
setScalingPolicies
(List<Object> value) Rule that controls how a fleet is scaled.void
setScalingPolicies
(IResolvable value) Rule that controls how a fleet is scaled.void
setScriptId
(String value) The unique identifier for a Realtime configuration script to be deployed on fleet instances.void
setServerLaunchParameters
(String value) Deprecated.this property has been deprecatedvoid
setServerLaunchPath
(String value) Deprecated.this property has been deprecatedMethods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrFleetId
A unique identifier for the fleet. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getName
A descriptive label that is associated with a fleet. -
setName
A descriptive label that is associated with a fleet. -
getAnywhereConfiguration
Amazon GameLift Anywhere configuration options. -
setAnywhereConfiguration
Amazon GameLift Anywhere configuration options. -
setAnywhereConfiguration
@Stability(Stable) public void setAnywhereConfiguration(@Nullable CfnFleet.AnywhereConfigurationProperty value) Amazon GameLift Anywhere configuration options. -
getApplyCapacity
Current resource capacity settings for managed EC2 fleets and managed container fleets. -
setApplyCapacity
Current resource capacity settings for managed EC2 fleets and managed container fleets. -
getBuildId
A unique identifier for a build to be deployed on the new fleet. -
setBuildId
A unique identifier for a build to be deployed on the new fleet. -
getCertificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. -
setCertificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. -
setCertificateConfiguration
@Stability(Stable) public void setCertificateConfiguration(@Nullable CfnFleet.CertificateConfigurationProperty value) Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. -
getComputeType
The type of compute resource used to host your game servers. -
setComputeType
The type of compute resource used to host your game servers. -
getDescription
A description for the fleet. -
setDescription
A description for the fleet. -
getDesiredEc2Instances
The number of EC2 instances that you want this fleet to host. -
setDesiredEc2Instances
The number of EC2 instances that you want this fleet to host. -
getEc2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. -
setEc2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. -
setEc2InboundPermissions
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. -
getEc2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. -
setEc2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use with managed EC2 fleets. -
getFleetType
Indicates whether to use On-Demand or Spot instances for this fleet. -
setFleetType
Indicates whether to use On-Demand or Spot instances for this fleet. -
getInstanceRoleArn
A unique identifier for an IAM role that manages access to your AWS services. -
setInstanceRoleArn
A unique identifier for an IAM role that manages access to your AWS services. -
getInstanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
. -
setInstanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
. -
getLocations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet. -
setLocations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet. -
setLocations
A set of remote locations to deploy additional instances to and manage as a multi-location fleet. -
getLogPaths
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used. -
setLogPaths
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used. -
getMaxSize
The maximum number of instances that are allowed in the specified fleet location. -
setMaxSize
The maximum number of instances that are allowed in the specified fleet location. -
getMetricGroups
The name of an AWS CloudWatch metric group to add this fleet to. -
setMetricGroups
The name of an AWS CloudWatch metric group to add this fleet to. -
getMinSize
The minimum number of instances that are allowed in the specified fleet location. -
setMinSize
The minimum number of instances that are allowed in the specified fleet location. -
getNewGameSessionProtectionPolicy
The status of termination protection for active game sessions on the fleet. -
setNewGameSessionProtectionPolicy
The status of termination protection for active game sessions on the fleet. -
getPeerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. -
setPeerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. -
getPeerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. -
setPeerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. -
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
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
Instructions for how to launch and maintain server processes on instances in the fleet. -
setRuntimeConfiguration
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
Rule that controls how a fleet is scaled. -
setScalingPolicies
Rule that controls how a fleet is scaled. -
setScalingPolicies
Rule that controls how a fleet is scaled. -
getScriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances. -
setScriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances. -
getServerLaunchParameters
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used but is retained for backward compatibility. -
setServerLaunchParameters
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used but is retained for backward compatibility. -
getServerLaunchPath
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used. -
setServerLaunchPath
Deprecated.this property has been deprecated(deprecated) This parameter is no longer used.
-