Class IBuildFleet.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IBuildFleet
,IBuildFleet.Jsii$Default
,IFleet
,IFleet.Jsii$Default
,IGameSessionQueueDestination
,IGameSessionQueueDestination.Jsii$Default
,IGrantable
,IGrantable.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IBuildFleet
-
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.alpha.IBuildFleet
IBuildFleet.Jsii$Default, IBuildFleet.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IFleet
IFleet.Jsii$Default, IFleet.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IGameSessionQueueDestination
IGameSessionQueueDestination.Jsii$Default, IGameSessionQueueDestination.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable
IGrantable.Jsii$Default, IGrantable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final String
(experimental) The ARN of the fleet.final String
(experimental) The Identifier of the fleet.final IPrincipal
The principal to grant permissions to.final software.constructs.Node
getNode()
The tree node.final String
(experimental) The ARN(s) to put into the destination field for a game session queue.final Stack
getStack()
The stack in which this resource is defined.final Grant
grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant thegrantee
identity permissions to performactions
.final Metric
(experimental) Return the given named metric for this fleet.final Metric
metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this fleet.final Metric
(experimental) Instances withACTIVE
status, which means they are running active server processes.final Metric
(experimental) Instances withACTIVE
status, which means they are running active server processes.final Metric
(experimental) Target number of active instances that GameLift is working to maintain in the fleet.final Metric
(experimental) Target number of active instances that GameLift is working to maintain in the fleet.final Metric
(experimental) Active instances that are currently hosting zero (0) game sessions.final Metric
metricIdleInstances
(MetricOptions props) (experimental) Active instances that are currently hosting zero (0) game sessions.final Metric
(experimental) Number of spot instances that have been interrupted.final Metric
(experimental) Number of spot instances that have been interrupted.final Metric
(experimental) Maximum number of instances that are allowed for the fleet.final Metric
metricMaxInstances
(MetricOptions props) (experimental) Maximum number of instances that are allowed for the fleet.final Metric
(experimental) Minimum number of instances allowed for the fleet.final Metric
metricMinInstances
(MetricOptions props) (experimental) Minimum number of instances allowed for the fleet.final Metric
(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).final Metric
(experimental) Percentage of all active instances that are idle (calculated as IdleInstances / ActiveInstances).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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIFleet.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Specified by:
getEnv
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getEnv
in interfaceIFleet.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getStack
in interfaceIFleet.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getGrantPrincipal
The principal to grant permissions to.- Specified by:
getGrantPrincipal
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getGrantPrincipal
in interfaceIFleet.Jsii$Default
- Specified by:
getGrantPrincipal
in interfaceIGrantable
- Specified by:
getGrantPrincipal
in interfaceIGrantable.Jsii$Default
-
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 interfaceIBuildFleet.Jsii$Default
- Specified by:
getResourceArnForDestination
in interfaceIFleet.Jsii$Default
- Specified by:
getResourceArnForDestination
in interfaceIGameSessionQueueDestination
- Specified by:
getResourceArnForDestination
in interfaceIGameSessionQueueDestination.Jsii$Default
-
getFleetArn
(experimental) The ARN of the fleet.- Specified by:
getFleetArn
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getFleetArn
in interfaceIFleet
- Specified by:
getFleetArn
in interfaceIFleet.Jsii$Default
-
getFleetId
(experimental) The Identifier of the fleet.- Specified by:
getFleetId
in interfaceIBuildFleet.Jsii$Default
- Specified by:
getFleetId
in interfaceIFleet
- Specified by:
getFleetId
in interfaceIFleet.Jsii$Default
-
applyRemovalPolicy
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 interfaceIBuildFleet.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIFleet.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grant
@Stability(Experimental) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) (experimental) Grant thegrantee
identity permissions to performactions
.- Specified by:
grant
in interfaceIBuildFleet.Jsii$Default
- Specified by:
grant
in interfaceIFleet
- Specified by:
grant
in interfaceIFleet.Jsii$Default
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this fleet.- Specified by:
metric
in interfaceIBuildFleet.Jsii$Default
- Specified by:
metric
in interfaceIFleet
- Specified by:
metric
in interfaceIFleet.Jsii$Default
- Parameters:
metricName
- This parameter is required.props
-
-
metric
(experimental) Return the given named metric for this fleet. -
metricActiveInstances
@Stability(Experimental) @NotNull public final Metric metricActiveInstances(@Nullable MetricOptions props) (experimental) Instances withACTIVE
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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricActiveInstances
in interfaceIFleet
- Specified by:
metricActiveInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricActiveInstances
(experimental) Instances withACTIVE
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 interfaceIFleet
-
metricDesiredInstances
@Stability(Experimental) @NotNull public final 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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricDesiredInstances
in interfaceIFleet
- Specified by:
metricDesiredInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricDesiredInstances
(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 interfaceIFleet
-
metricIdleInstances
@Stability(Experimental) @NotNull public final 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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricIdleInstances
in interfaceIFleet
- Specified by:
metricIdleInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricIdleInstances
(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 interfaceIFleet
-
metricInstanceInterruptions
@Stability(Experimental) @NotNull public final Metric metricInstanceInterruptions(@Nullable MetricOptions props) (experimental) Number of spot instances that have been interrupted.- Specified by:
metricInstanceInterruptions
in interfaceIBuildFleet.Jsii$Default
- Specified by:
metricInstanceInterruptions
in interfaceIFleet
- Specified by:
metricInstanceInterruptions
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricInstanceInterruptions
(experimental) Number of spot instances that have been interrupted.- Specified by:
metricInstanceInterruptions
in interfaceIFleet
-
metricMaxInstances
@Stability(Experimental) @NotNull public final 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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricMaxInstances
in interfaceIFleet
- Specified by:
metricMaxInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricMaxInstances
(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 interfaceIFleet
-
metricMinInstances
@Stability(Experimental) @NotNull public final 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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricMinInstances
in interfaceIFleet
- Specified by:
metricMinInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricMinInstances
(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 interfaceIFleet
-
metricPercentIdleInstances
@Stability(Experimental) @NotNull public final 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 interfaceIBuildFleet.Jsii$Default
- Specified by:
metricPercentIdleInstances
in interfaceIFleet
- Specified by:
metricPercentIdleInstances
in interfaceIFleet.Jsii$Default
- Parameters:
props
-
-
metricPercentIdleInstances
(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 interfaceIFleet
-