software.amazon.awscdk.services.gamelift

Interface CfnBuildProps

All Known Implementing Classes:

CfnBuildProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:50.423Z")
public interface CfnBuildProps

Properties for defining a `CfnBuild`.

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.*;
 CfnBuildProps cfnBuildProps = CfnBuildProps.builder()
         .name("name")
         .operatingSystem("operatingSystem")
         .storageLocation(S3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .objectVersion("objectVersion")
                 .build())
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBuildProps.Builder A builder for CfnBuildProps
static class	CfnBuildProps.Jsii$Proxy An implementation for CfnBuildProps

Method Summary

Modifier and Type	Method and Description
static CfnBuildProps.Builder	builder()
default java.lang.String	getName() A descriptive label that is associated with a build.
default java.lang.String	getOperatingSystem() The operating system that the game server binaries are built to run on.
default java.lang.Object	getStorageLocation() Information indicating where your game build files are stored.
default java.lang.String	getVersion() Version information that is associated with this build.

Method Detail

getName

default java.lang.String getName()

A descriptive label that is associated with a build.

Build names do not need to be unique.

getOperatingSystem

default java.lang.String getOperatingSystem()

The operating system that the game server binaries are built to run on.

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.

getStorageLocation

default java.lang.Object getStorageLocation()

Information indicating where your game build files are stored.

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.

getVersion

default java.lang.String getVersion()

Version information that is associated with this build.

Version strings do not need to be unique.

builder

static CfnBuildProps.Builder builder()

Returns:

a CfnBuildProps.Builder of CfnBuildProps