class BuildBase
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.GameLift.Alpha.BuildBase |
Go | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#BuildBase |
Java | software.amazon.awscdk.services.gamelift.alpha.BuildBase |
Python | aws_cdk.aws_gamelift_alpha.BuildBase |
TypeScript (source) | @aws-cdk/aws-gamelift-alpha ยป BuildBase |
Implements
IConstruct
, IDependable
, IResource
, IBuild
, IGrantable
Extends
Resource
Implemented by
Build
Base class for new and imported GameLift server build.
Initializer
new BuildBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
build | string | The ARN of the build. |
build | string | The Identifier of the build. |
env | Resource | The environment this resource belongs to. |
grant | IPrincipal | The principal to grant permissions to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
buildArn
Type:
string
The ARN of the build.
buildId
Type:
string
The Identifier of the build.
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.
grantPrincipal
Type:
IPrincipal
The principal to grant permissions to.
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. |
to | Returns a string representation of this construct. |
RemovalPolicy(policy)
applypublic 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
).
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.