@aws-cdk_aws-gamelift-alpha.GameServerGroupBase

class GameServerGroupBase ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.GameServerGroupBase
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#GameServerGroupBase
Javasoftware.amazon.awscdk.services.gamelift.alpha.GameServerGroupBase
Pythonaws_cdk.aws_gamelift_alpha.GameServerGroupBase
TypeScript (source)@aws-cdk/aws-gamelift-alpha ยป GameServerGroupBase

Implements IConstruct, IDependable, IResource, IGameServerGroup, IGrantable

Extends Resource

Implemented by GameServerGroup

Base class for new and imported GameLift FleetIQ game server group.

Initializer

new GameServerGroupBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
autoScalingGroupArn๐Ÿ”นstringThe ARN of the generated AutoScaling group.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
gameServerGroupArn๐Ÿ”นstringThe ARN of the game server group.
gameServerGroupName๐Ÿ”นstringThe name of the game server group.
grantPrincipal๐Ÿ”นIPrincipalThe principal this GameLift game server group is using.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.

autoScalingGroupArn๐Ÿ”น

Type: string

The ARN of the generated AutoScaling group.


env๐Ÿ”น

Type: ResourceEnvironment

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.


gameServerGroupArn๐Ÿ”น

Type: string

The ARN of the game server group.


gameServerGroupName๐Ÿ”น

Type: string

The name of the game server group.


grantPrincipal๐Ÿ”น

Type: IPrincipal

The principal this GameLift game server group is using.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
grant(grantee, ...actions)๐Ÿ”นGrant the grantee identity permissions to perform actions.
metric(metricName, props?)๐Ÿ”นReturn the given named metric for this fleet.
toString()๐Ÿ”นReturns a string representation of this construct.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


grant(grantee, ...actions)๐Ÿ”น

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

  • grantee IGrantable
  • actions string

Returns

  • Grant

Grant the grantee identity permissions to perform actions.


metric(metricName, props?)๐Ÿ”น

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

  • metricName string
  • props MetricOptions

Returns

  • Metric

Return the given named metric for this fleet.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.