@aws-cdk_aws-gamelift-alpha.IBuild

interface IBuild ๐Ÿ”น

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

Implemented by Build

Obtainable from Build.fromBuildArn(), Build.fromBuildAttributes(), Build.fromBuildId()

Your custom-built game server software that runs on GameLift and hosts game sessions for your players.

A game build represents the set of files that run your game server on a particular operating system. You can have many different builds, such as for different flavors of your game. The game build must be integrated with the GameLift service. You upload game build files to the GameLift service in the Regions where you plan to set up fleets.

See also: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html

Properties

NameTypeDescription
buildArn๐Ÿ”นstringThe ARN of the build.
buildId๐Ÿ”นstringThe Identifier of the build.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
grantPrincipal๐Ÿ”นIPrincipalThe principal to grant permissions to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe 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: 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.


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

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

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