Package software.amazon.awscdk.services.gamelift.alpha

Interface IFleet.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IFleet, IGameSessionQueueDestination, IGameSessionQueueDestination.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IBuildFleet.Jsii$Default
All Known Implementing Classes:
IBuildFleet.Jsii$Proxy, IFleet.Jsii$Proxy
Enclosing interface:
IFleet
@Internal public static interface IFleet.Jsii$Default extends IFleet, IResource.Jsii$Default, IGameSessionQueueDestination.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IFleet.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getGrantPrincipal

      @Stability(Stable) @NotNull default IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in interface IGrantable.Jsii$Default

    • getResourceArnForDestination

      @Stability(Experimental) @NotNull default String getResourceArnForDestination()
      (experimental) The ARN(s) to put into the destination field for a game session queue.

      This property is for cdk modules to consume only. You should not need to use this property. Instead, use dedicated identifier on each components.

      Specified by:
      getResourceArnForDestination in interface IGameSessionQueueDestination
      Specified by:
      getResourceArnForDestination in interface IGameSessionQueueDestination.Jsii$Default

    • getFleetArn

      @Stability(Experimental) @NotNull default String getFleetArn()
      (experimental) The ARN of the fleet.
      Specified by:
      getFleetArn in interface IFleet

    • getFleetId

      @Stability(Experimental) @NotNull default String getFleetId()
      (experimental) The Identifier of the fleet.
      Specified by:
      getFleetId in interface IFleet

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grant

      @Stability(Experimental) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grant the grantee identity permissions to perform actions.

      Specified by:
      grant in interface IFleet
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this fleet.

      Specified by:
      metric in interface IFleet
      Parameters:
      metricName - This parameter is required.
      props -

    • metricActiveInstances

      @Stability(Experimental) @NotNull default Metric metricActiveInstances(@Nullable MetricOptions props)
      (experimental) Instances with ACTIVE status, which means they are running active server processes.

      The count includes idle instances and those that are hosting one or more game sessions. This metric measures current total instance capacity.

      This metric can be used with automatic scaling.

      Specified by:
      metricActiveInstances in interface IFleet
      Parameters:
      props -

    • metricDesiredInstances

      @Stability(Experimental) @NotNull default Metric metricDesiredInstances(@Nullable MetricOptions props)
      (experimental) Target number of active instances that GameLift is working to maintain in the fleet.

      With automatic scaling, this value is determined based on the scaling policies currently in force. Without automatic scaling, this value is set manually. This metric is not available when viewing data for fleet metric groups.

      Specified by:
      metricDesiredInstances in interface IFleet
      Parameters:
      props -

    • metricIdleInstances

      @Stability(Experimental) @NotNull default Metric metricIdleInstances(@Nullable MetricOptions props)
      (experimental) Active instances that are currently hosting zero (0) game sessions.

      This metric measures capacity that is available but unused. This metric can be used with automatic scaling.

      Specified by:
      metricIdleInstances in interface IFleet
      Parameters:
      props -

    • metricInstanceInterruptions

      @Stability(Experimental) @NotNull default Metric metricInstanceInterruptions(@Nullable MetricOptions props)
      (experimental) Number of spot instances that have been interrupted.

      Specified by:
      metricInstanceInterruptions in interface IFleet
      Parameters:
      props -

    • metricMaxInstances

      @Stability(Experimental) @NotNull default Metric metricMaxInstances(@Nullable MetricOptions props)
      (experimental) Maximum number of instances that are allowed for the fleet.

      A fleet's instance maximum determines the capacity ceiling during manual or automatic scaling up. This metric is not available when viewing data for fleet metric groups.

      Specified by:
      metricMaxInstances in interface IFleet
      Parameters:
      props -

    • metricMinInstances

      @Stability(Experimental) @NotNull default Metric metricMinInstances(@Nullable MetricOptions props)
      (experimental) Minimum number of instances allowed for the fleet.

      A fleet's instance minimum determines the capacity floor during manual or automatic scaling down. This metric is not available when viewing data for fleet metric groups.

      Specified by:
      metricMinInstances in interface IFleet
      Parameters:
      props -

    • metricPercentIdleInstances

      @Stability(Experimental) @NotNull default Metric metricPercentIdleInstances(@Nullable MetricOptions props)
      (experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).

      This metric can be used for automatic scaling.

      Specified by:
      metricPercentIdleInstances in interface IFleet
      Parameters:
      props -