Class CfnFleetProps.Jsii$Proxy
- All Implemented Interfaces:
CfnFleetProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnFleetProps
CfnFleetProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.CfnFleetProps
CfnFleetProps.Builder, CfnFleetProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnFleetProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnFleetProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Amazon GameLift Anywhere configuration options.final String
Current resource capacity settings for managed EC2 fleets.final String
A unique identifier for a build to be deployed on the new fleet.final Object
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.final String
The type of compute resource used to host your game servers.final Object
*This data type is currently not available.final String
A description for the fleet.final Number
The number of EC2 instances that you want this fleet to host.final Object
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.final String
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.final String
Indicates whether to use On-Demand or Spot instances for this fleet.final String
A unique identifier for an IAM role with access permissions to other AWS services.final String
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.final Object
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.(deprecated) This parameter is no longer used.final 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.final Number
The minimum number of instances that are allowed in the specified fleet location.final String
getName()
A descriptive label that is associated with a fleet.final String
The status of termination protection for active game sessions on the fleet.final String
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.final String
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.final 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.final Object
Instructions for how to launch and maintain server processes on instances in the fleet.final Object
Rule that controls how a fleet is scaled.final String
The unique identifier for a Realtime configuration script to be deployed on fleet instances.final String
(deprecated) This parameter is no longer used but is retained for backward compatibility.final String
(deprecated) This parameter is no longer used.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnFleetProps.Builder
.
-
-
Method Details
-
getName
Description copied from interface:CfnFleetProps
A descriptive label that is associated with a fleet.Fleet names do not need to be unique.
- Specified by:
getName
in interfaceCfnFleetProps
- See Also:
-
getAnywhereConfiguration
Description copied from interface:CfnFleetProps
Amazon GameLift Anywhere configuration options.- Specified by:
getAnywhereConfiguration
in interfaceCfnFleetProps
- See Also:
-
getApplyCapacity
Description copied from interface:CfnFleetProps
Current resource capacity settings for managed EC2 fleets.For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity
- Specified by:
getApplyCapacity
in interfaceCfnFleetProps
- See Also:
-
getBuildId
Description copied from interface:CfnFleetProps
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.- Specified by:
getBuildId
in interfaceCfnFleetProps
- See Also:
-
getCertificateConfiguration
Description copied from interface:CfnFleetProps
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 .
- Specified by:
getCertificateConfiguration
in interfaceCfnFleetProps
- See Also:
-
getComputeType
Description copied from interface:CfnFleetProps
The type of compute resource used to host your game servers.EC2
– The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting.CONTAINER
– Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify theContainerGroupsConfiguration
parameter.ANYWHERE
– Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set theAnywhereConfiguration
parameter.
- Specified by:
getComputeType
in interfaceCfnFleetProps
- See Also:
-
getContainerGroupsConfiguration
Description copied from interface:CfnFleetProps
*This data type is currently not available.It is under improvement as we respond to customer feedback from the Containers public preview.*
Configuration details for a set of container groups, for use when creating a fleet with compute type
CONTAINER
.Used with:
CreateFleet
- Specified by:
getContainerGroupsConfiguration
in interfaceCfnFleetProps
- See Also:
-
getDescription
Description copied from interface:CfnFleetProps
A description for the fleet.- Specified by:
getDescription
in interfaceCfnFleetProps
- See Also:
-
getDesiredEc2Instances
Description copied from interface:CfnFleetProps
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.
- Specified by:
getDesiredEc2Instances
in interfaceCfnFleetProps
- See Also:
-
getEc2InboundPermissions
Description copied from interface:CfnFleetProps
The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.Set this parameter for EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call
UpdateFleetPortSettings
to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
- Specified by:
getEc2InboundPermissions
in interfaceCfnFleetProps
- See Also:
-
getEc2InstanceType
Description copied from interface:CfnFleetProps
The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container fleets.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.
- Specified by:
getEc2InstanceType
in interfaceCfnFleetProps
- See Also:
-
getFleetType
Description copied from interface:CfnFleetProps
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.- Specified by:
getFleetType
in interfaceCfnFleetProps
- See Also:
-
getInstanceRoleArn
Description copied from interface:CfnFleetProps
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 . This attribute is used with fleets where
ComputeType
is "EC2".- Specified by:
getInstanceRoleArn
in interfaceCfnFleetProps
- See Also:
-
getInstanceRoleCredentialsProvider
Description copied from interface:CfnFleetProps
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 . This attribute is used with fleets where
ComputeType
is "EC2".- Specified by:
getInstanceRoleCredentialsProvider
in interfaceCfnFleetProps
- See Also:
-
getLocations
Description copied from interface:CfnFleetProps
A set of remote locations to deploy additional instances to and manage as a multi-location fleet.Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift. Provide a list of one or more AWS Region codes, such as
us-west-2
, or Local Zone names. When using this parameter, Amazon GameLift requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift service locations for managed hosting.- Specified by:
getLocations
in interfaceCfnFleetProps
- See Also:
-
getLogPaths
Description copied from interface:CfnFleetProps
(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()
- Specified by:
getLogPaths
in interfaceCfnFleetProps
- See Also:
-
getMaxSize
Description copied from interface:CfnFleetProps
The maximum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 1.
- Specified by:
getMaxSize
in interfaceCfnFleetProps
- See Also:
-
getMetricGroups
Description copied from interface:CfnFleetProps
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.
- Specified by:
getMetricGroups
in interfaceCfnFleetProps
- See Also:
-
getMinSize
Description copied from interface:CfnFleetProps
The minimum number of instances that are allowed in the specified fleet location.If this parameter is not set, the default is 0.
- Specified by:
getMinSize
in interfaceCfnFleetProps
- See Also:
-
getNewGameSessionProtectionPolicy
Description copied from interface:CfnFleetProps
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.
- Specified by:
getNewGameSessionProtectionPolicy
in interfaceCfnFleetProps
- See Also:
-
getPeerVpcAwsAccountId
Description copied from interface:CfnFleetProps
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.
- Specified by:
getPeerVpcAwsAccountId
in interfaceCfnFleetProps
- See Also:
-
getPeerVpcId
Description copied from interface:CfnFleetProps
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 .
- Specified by:
getPeerVpcId
in interfaceCfnFleetProps
- See Also:
-
getResourceCreationLimitPolicy
Description copied from interface:CfnFleetProps
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.- Specified by:
getResourceCreationLimitPolicy
in interfaceCfnFleetProps
- See Also:
-
getRuntimeConfiguration
Description copied from interface:CfnFleetProps
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.- Specified by:
getRuntimeConfiguration
in interfaceCfnFleetProps
- See Also:
-
getScalingPolicies
Description copied from interface:CfnFleetProps
Rule that controls how a fleet is scaled.Scaling policies are uniquely identified by the combination of name and fleet ID.
- Specified by:
getScalingPolicies
in interfaceCfnFleetProps
- See Also:
-
getScriptId
Description copied from interface:CfnFleetProps
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.- Specified by:
getScriptId
in interfaceCfnFleetProps
- See Also:
-
getServerLaunchParameters
Description copied from interface:CfnFleetProps
(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.
- Specified by:
getServerLaunchParameters
in interfaceCfnFleetProps
- See Also:
-
getServerLaunchPath
Description copied from interface:CfnFleetProps
(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.
- Specified by:
getServerLaunchPath
in interfaceCfnFleetProps
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-