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.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.CfnFleetProps
CfnFleetProps.Builder, CfnFleetProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnFleetProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnFleetProps.Builder.protectedJsii$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.JsonNodefinal booleanfinal ObjectAmazon GameLift Servers Anywhere configuration options.final StringCurrent resource capacity settings for managed EC2 fleets and managed container fleets.final StringA unique identifier for a build to be deployed on the new fleet.final ObjectPrompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.final StringThe type of compute resource used to host your game servers.final StringA description for the fleet.final Number(deprecated) [DEPRECATED] The number of EC2 instances that you want this fleet to host.final ObjectThe IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.final StringThe Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.final StringIndicates whether to use On-Demand or Spot instances for this fleet.final StringA unique identifier for an IAM role that manages access to your AWS services.final StringIndicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn.final ObjectA 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(deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.The name of an AWS CloudWatch metric group to add this fleet to.final Number(deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.final StringgetName()A descriptive label that is associated with a fleet.final StringThe status of termination protection for active game sessions on the fleet.final StringUsed when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.final StringA unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.final ObjectA 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 ObjectInstructions for how to launch and maintain server processes on instances in the fleet.final ObjectRule that controls how a fleet is scaled.final StringThe 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.getTags()An array of key-value pairs to apply to this resource.final inthashCode()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:CfnFleetPropsA descriptive label that is associated with a fleet.Fleet names do not need to be unique.
- Specified by:
getNamein interfaceCfnFleetProps- See Also:
-
getAnywhereConfiguration
Description copied from interface:CfnFleetPropsAmazon GameLift Servers Anywhere configuration options.Returns union: either
IResolvableorCfnFleet.AnywhereConfigurationProperty- Specified by:
getAnywhereConfigurationin interfaceCfnFleetProps- See Also:
-
getApplyCapacity
Description copied from interface:CfnFleetPropsCurrent resource capacity settings for managed EC2 fleets and managed container 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:
getApplyCapacityin interfaceCfnFleetProps- See Also:
-
getBuildId
Description copied from interface:CfnFleetPropsA 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
READYstatus. This fleet setting cannot be changed once the fleet is created.- Specified by:
getBuildIdin interfaceCfnFleetProps- See Also:
-
getCertificateConfiguration
Description copied from interface:CfnFleetPropsPrompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the
CertificateConfigurationisDISABLED. You can't change this property after you create the fleet.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 Certificate Manager User Guide .
Returns union: either
IResolvableorCfnFleet.CertificateConfigurationProperty- Specified by:
getCertificateConfigurationin interfaceCfnFleetProps- See Also:
-
getComputeType
Description copied from interface:CfnFleetPropsThe 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.ANYWHERE– Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set theAnywhereConfigurationparameter.
- Specified by:
getComputeTypein interfaceCfnFleetProps- See Also:
-
getDescription
Description copied from interface:CfnFleetPropsA description for the fleet.- Specified by:
getDescriptionin interfaceCfnFleetProps- See Also:
-
getDesiredEc2Instances
Description copied from interface:CfnFleetProps(deprecated) [DEPRECATED] 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:
getDesiredEc2Instancesin interfaceCfnFleetProps- See Also:
-
getEc2InboundPermissions
Description copied from interface:CfnFleetPropsThe 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 managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call 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 Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnFleet.IpPermissionProperty>- Specified by:
getEc2InboundPermissionsin interfaceCfnFleetProps- See Also:
-
getEc2InstanceType
Description copied from interface:CfnFleetPropsThe Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 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:
getEc2InstanceTypein interfaceCfnFleetProps- See Also:
-
getFleetType
Description copied from interface:CfnFleetPropsIndicates 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:
getFleetTypein interfaceCfnFleetProps- See Also:
-
getInstanceRoleArn
Description copied from interface:CfnFleetPropsA 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 attribute is used with fleets where
ComputeTypeisEC2.- Specified by:
getInstanceRoleArnin interfaceCfnFleetProps- See Also:
-
getInstanceRoleCredentialsProvider
Description copied from interface:CfnFleetPropsIndicates 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
ComputeTypeisEC2.- Specified by:
getInstanceRoleCredentialsProviderin interfaceCfnFleetProps- See Also:
-
getLocations
Description copied from interface:CfnFleetPropsA 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 Servers. 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 Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnFleet.LocationConfigurationProperty>- Specified by:
getLocationsin 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:
getLogPathsin interfaceCfnFleetProps- See Also:
-
getMaxSize
Description copied from interface:CfnFleetProps(deprecated) [DEPRECATED] The maximum value that is allowed for the fleet's instance count.When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.
- Specified by:
getMaxSizein interfaceCfnFleetProps- See Also:
-
getMetricGroups
Description copied from interface:CfnFleetPropsThe 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:
getMetricGroupsin interfaceCfnFleetProps- See Also:
-
getMinSize
Description copied from interface:CfnFleetProps(deprecated) [DEPRECATED] The minimum value allowed for the fleet's instance count.When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.
- Specified by:
getMinSizein interfaceCfnFleetProps- See Also:
-
getNewGameSessionProtectionPolicy
Description copied from interface:CfnFleetPropsThe 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
ACTIVEstatus cannot be terminated during a scale-down event.
- Specified by:
getNewGameSessionProtectionPolicyin interfaceCfnFleetProps- See Also:
-
getPeerVpcAwsAccountId
Description copied from interface:CfnFleetPropsUsed when peering your Amazon GameLift Servers 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:
getPeerVpcAwsAccountIdin interfaceCfnFleetProps- See Also:
-
getPeerVpcId
Description copied from interface:CfnFleetPropsA unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers 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 Servers Fleets .
- Specified by:
getPeerVpcIdin interfaceCfnFleetProps- See Also:
-
getResourceCreationLimitPolicy
Description copied from interface:CfnFleetPropsA 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
IResolvableorCfnFleet.ResourceCreationLimitPolicyProperty- Specified by:
getResourceCreationLimitPolicyin interfaceCfnFleetProps- See Also:
-
getRuntimeConfiguration
Description copied from interface:CfnFleetPropsInstructions 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
RuntimeConfigurationparameter is required unless the fleet is being configured using the older parametersServerLaunchPathandServerLaunchParameters, which are still supported for backward compatibility.Returns union: either
IResolvableorCfnFleet.RuntimeConfigurationProperty- Specified by:
getRuntimeConfigurationin interfaceCfnFleetProps- See Also:
-
getScalingPolicies
Description copied from interface:CfnFleetPropsRule that controls how a fleet is scaled.Scaling policies are uniquely identified by the combination of name and fleet ID.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnFleet.ScalingPolicyProperty>- Specified by:
getScalingPoliciesin interfaceCfnFleetProps- See Also:
-
getScriptId
Description copied from interface:CfnFleetPropsThe 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 Servers prior to creating the fleet. This fleet property cannot be changed later.
You can't use the
!Refcommand to reference a script created with a CloudFormation template for the fleet propertyScriptId. Instead, useFn::GetAtt Script.ArnorFn::GetAtt Script.Idto retrieve either of these properties as input forScriptId. Alternatively, enter aScriptIdstring manually.- Specified by:
getScriptIdin 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:
getServerLaunchParametersin 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:
getServerLaunchPathin interfaceCfnFleetProps- See Also:
-
getTags
Description copied from interface:CfnFleetPropsAn array of key-value pairs to apply to this resource.- Specified by:
getTagsin interfaceCfnFleetProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-