Package software.amazon.awscdk.services.gamelift

Class CfnFleetProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.gamelift.CfnFleetProps.Jsii$Proxy
All Implemented Interfaces:
CfnFleetProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnFleetProps
@Stability(Stable) @Internal public static final class CfnFleetProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnFleetProps
An implementation for 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

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnFleetProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnFleetProps.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 Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Object
    getAnywhereConfiguration()
    AWS::GameLift::Fleet.AnywhereConfiguration.
    final String
    getBuildId()
    A unique identifier for a build to be deployed on the new fleet.
    final Object
    getCertificateConfiguration()
    Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.
    final String
    getComputeType()
    The type of compute resource used to host your game servers.
    final String
    getDescription()
    A description for the fleet.
    final Number
    getDesiredEc2Instances()
    The number of EC2 instances that you want this fleet to host.
    final Object
    getEc2InboundPermissions()
    The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.
    final String
    getEc2InstanceType()
    The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.
    final String
    getFleetType()
    Indicates whether to use On-Demand or Spot instances for this fleet.
    final String
    getInstanceRoleArn()
    A unique identifier for an IAM role that manages access to your AWS services.
    final Object
    getLocations()
    A set of remote locations to deploy additional instances to and manage as part of the fleet.
    final Number
    getMaxSize()
    The maximum number of instances that are allowed in the specified fleet location.
    final List<String>
    getMetricGroups()
    The name of an AWS CloudWatch metric group to add this fleet to.
    final Number
    getMinSize()
    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
    getNewGameSessionProtectionPolicy()
    The status of termination protection for active game sessions on the fleet.
    final String
    getPeerVpcAwsAccountId()
    Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC.
    final String
    getPeerVpcId()
    A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
    final 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.
    final Object
    getRuntimeConfiguration()
    Instructions for how to launch and maintain server processes on instances in the fleet.
    final String
    getScriptId()
    The unique identifier for a Realtime configuration script to be deployed on fleet instances.
    final int
    hashCode()
     

    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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • 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

      protected Jsii$Proxy(CfnFleetProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnFleetProps.Builder.

  • Method Details

    • getName

      public final String 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 interface CfnFleetProps

    • getAnywhereConfiguration

      public final Object getAnywhereConfiguration()
      Description copied from interface: CfnFleetProps
      AWS::GameLift::Fleet.AnywhereConfiguration.
      Specified by:
      getAnywhereConfiguration in interface CfnFleetProps

    • getBuildId

      public final String 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 interface CfnFleetProps

    • getCertificateConfiguration

      public final Object 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 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 .

      Specified by:
      getCertificateConfiguration in interface CfnFleetProps

    • getComputeType

      public final String getComputeType()
      Description copied from interface: CfnFleetProps
      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.

      Specified by:
      getComputeType in interface CfnFleetProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnFleetProps
      A description for the fleet.
      Specified by:
      getDescription in interface CfnFleetProps

    • getDesiredEc2Instances

      public final Number 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 interface CfnFleetProps

    • getEc2InboundPermissions

      public final Object getEc2InboundPermissions()
      Description copied from interface: CfnFleetProps
      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.

      Specified by:
      getEc2InboundPermissions in interface CfnFleetProps

    • getEc2InstanceType

      public final String getEc2InstanceType()
      Description copied from interface: CfnFleetProps
      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.

      Specified by:
      getEc2InstanceType in interface CfnFleetProps

    • getFleetType

      public final String 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 property cannot be changed after the fleet is created.

      Specified by:
      getFleetType in interface CfnFleetProps

    • getInstanceRoleArn

      public final String getInstanceRoleArn()
      Description copied from interface: CfnFleetProps
      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.

      Specified by:
      getInstanceRoleArn in interface CfnFleetProps

    • getLocations

      public final Object getLocations()
      Description copied from interface: CfnFleetProps
      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.

      Specified by:
      getLocations in interface CfnFleetProps

    • getMaxSize

      public final Number 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 interface CfnFleetProps

    • getMetricGroups

      public final List<String> 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 interface CfnFleetProps

    • getMinSize

      public final Number 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 interface CfnFleetProps

    • getNewGameSessionProtectionPolicy

      public final String 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 interface CfnFleetProps

    • getPeerVpcAwsAccountId

      public final String 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 interface CfnFleetProps

    • getPeerVpcId

      public final String 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 interface CfnFleetProps

    • getResourceCreationLimitPolicy

      public final Object 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 interface CfnFleetProps

    • getRuntimeConfiguration

      public final Object 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 parameters ServerLaunchPath and ServerLaunchParameters , which are still supported for backward compatibility.

      Specified by:
      getRuntimeConfiguration in interface CfnFleetProps

    • getScriptId

      public final String 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 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.

      Specified by:
      getScriptId in interface CfnFleetProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object