Class CfnBuild
A CloudFormation AWS::GameLift::Build
.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.AWS.GameLift.dll
Syntax (csharp)
public class CfnBuild : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBuild
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::GameLift::Build
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-build.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnBuild = new CfnBuild(this, "MyCfnBuild", new CfnBuildProps {
Name = "name",
OperatingSystem = "operatingSystem",
ServerSdkVersion = "serverSdkVersion",
StorageLocation = new StorageLocationProperty {
Bucket = "bucket",
Key = "key",
RoleArn = "roleArn",
// the properties below are optional
ObjectVersion = "objectVersion"
},
Version = "version"
});
Synopsis
Constructors
CfnBuild(Construct, String, ICfnBuildProps) | Create a new |
CfnBuild(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBuild(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrBuildId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | A descriptive label that is associated with a build. |
OperatingSystem | The operating system that your game server binaries run on. |
ServerSdkVersion | The Amazon GameLift Server SDK version used to develop your game server. |
StorageLocation | Information indicating where your game build files are stored. |
Version | Version information that is associated with this build. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBuild(Construct, String, ICfnBuildProps)
Create a new AWS::GameLift::Build
.
public CfnBuild(Construct scope, string id, ICfnBuildProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnBuildProps
- resource properties.
CfnBuild(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBuild(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBuild(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBuild(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrBuildId
public virtual string AttrBuildId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: BuildId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
A descriptive label that is associated with a build.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Build names do not need to be unique.
OperatingSystem
The operating system that your game server binaries run on.
public virtual string OperatingSystem { get; set; }
Property Value
System.String
Remarks
This value determines the type of fleet resources that you use for this build. If your game build contains multiple executables, they all must run on the same operating system. You must specify a valid operating system in this request. There is no default value. You can't change a build's operating system later.
If you have active fleets using the Windows Server 2012 operating system, you can continue to create new builds using this OS until October 10, 2023, when Microsoft ends its support. All others must use Windows Server 2016 when creating new Windows-based builds.
ServerSdkVersion
The Amazon GameLift Server SDK version used to develop your game server.
public virtual string ServerSdkVersion { get; set; }
Property Value
System.String
Remarks
StorageLocation
Information indicating where your game build files are stored.
public virtual object StorageLocation { get; set; }
Property Value
System.Object
Remarks
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.
Version
Version information that is associated with this build.
public virtual string Version { get; set; }
Property Value
System.String
Remarks
Version strings do not need to be unique.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>