class GameServerGroupBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.Alpha.GameServerGroupBase |
![]() | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#GameServerGroupBase |
![]() | software.amazon.awscdk.services.gamelift.alpha.GameServerGroupBase |
![]() | aws_cdk.aws_gamelift_alpha.GameServerGroupBase |
![]() | @aws-cdk/aws-gamelift-alpha ยป GameServerGroupBase |
Implements
IConstruct
, IDependable
, IResource
, IGame
, IGrantable
Extends
Resource
Implemented by
Game
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
Resource
Props
Properties
Name | Type | Description |
---|---|---|
auto | string | The ARN of the generated AutoScaling group. |
env | Resource | The environment this resource belongs to. |
game | string | The ARN of the game server group. |
game | string | The name of the game server group. |
grant | IPrincipal | The principal this GameLift game server group is using. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
autoScalingGroupArn
Type:
string
The ARN of the generated AutoScaling group.
env
Type:
Resource
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
Name | Description |
---|---|
apply | 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. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
grant(grantee, ...actions)
public grant(grantee: IGrantable, ...actions: string[]): Grant
Parameters
- grantee
IGrantable
- actions
string
Returns
Grant the grantee
identity permissions to perform actions
.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this fleet.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.