@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:39.461Z") @Stability(value=Stable) public class CfnBuild extends CfnResource implements IInspectable
The AWS::GameLift::Build resource creates a game server build that is installed and run on instances in an Amazon GameLift fleet. This resource points to an Amazon S3 location that contains a zip file with all of the components of the game server build.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;
CfnBuild cfnBuild = CfnBuild.Builder.create(this, "MyCfnBuild")
.name("name")
.operatingSystem("operatingSystem")
.storageLocation(S3LocationProperty.builder()
.bucket("bucket")
.key("key")
.roleArn("roleArn")
// the properties below are optional
.objectVersion("objectVersion")
.build())
.version("version")
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnBuild.Builder
A fluent builder for
CfnBuild. |
static interface |
CfnBuild.S3LocationProperty
The location in Amazon S3 where build or script files are stored for access by Amazon GameLift.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnBuild(software.constructs.Construct scope,
String id)
Create a new `AWS::GameLift::Build`.
|
|
CfnBuild(software.constructs.Construct scope,
String id,
CfnBuildProps props)
Create a new `AWS::GameLift::Build`.
|
protected |
CfnBuild(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnBuild(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
protected Map<String,Object> |
getCfnProperties() |
String |
getName()
A descriptive label that is associated with a build.
|
String |
getOperatingSystem()
The operating system that the game server binaries are built to run on.
|
Object |
getStorageLocation()
Information indicating where your game build files are stored.
|
String |
getVersion()
Version information that is associated with this build.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setName(String value)
A descriptive label that is associated with a build.
|
void |
setOperatingSystem(String value)
The operating system that the game server binaries are built to run on.
|
void |
setStorageLocation(CfnBuild.S3LocationProperty value)
Information indicating where your game build files are stored.
|
void |
setStorageLocation(IResolvable value)
Information indicating where your game build files are stored.
|
void |
setVersion(String value)
Version information that is associated with this build.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnBuild(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnBuild(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnBuild(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@Nullable
CfnBuildProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties.@Stability(value=Stable)
public CfnBuild(@NotNull
software.constructs.Construct scope,
@NotNull
String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @Nullable public String getName()
Build names do not need to be unique.
@Stability(value=Stable)
public void setName(@Nullable
String value)
Build names do not need to be unique.
@Stability(value=Stable) @Nullable public String getOperatingSystem()
This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
@Stability(value=Stable)
public void setOperatingSystem(@Nullable
String value)
This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.
@Stability(value=Stable) @Nullable public Object getStorageLocation()
Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.
@Stability(value=Stable)
public void setStorageLocation(@Nullable
CfnBuild.S3LocationProperty value)
Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.
@Stability(value=Stable)
public void setStorageLocation(@Nullable
IResolvable value)
Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.
If a StorageLocation is specified, the size of your file can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0.
@Stability(value=Stable) @Nullable public String getVersion()
Version strings do not need to be unique.
@Stability(value=Stable)
public void setVersion(@Nullable
String value)
Version strings do not need to be unique.
Copyright © 2022. All rights reserved.