Package software.amazon.awscdk.services.gamelift

Class CfnBuild

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.gamelift.CfnBuild
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.854Z") @Stability(Stable) public class CfnBuild extends CfnResource implements IInspectable
A CloudFormation AWS::GameLift::Build.

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")
         .serverSdkVersion("serverSdkVersion")
         .storageLocation(StorageLocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .objectVersion("objectVersion")
                 .build())
         .version("version")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBuild

      protected CfnBuild(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBuild

      protected CfnBuild(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBuild

      @Stability(Stable) public CfnBuild(@NotNull Construct scope, @NotNull String id, @Nullable CfnBuildProps props)
      Create a new AWS::GameLift::Build.

      Parameters:
      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.

    • CfnBuild

      @Stability(Stable) public CfnBuild(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::GameLift::Build.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrBuildId

      @Stability(Stable) @NotNull public String getAttrBuildId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @Nullable public String getName()
      A descriptive label that is associated with a build.

      Build names do not need to be unique.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A descriptive label that is associated with a build.

      Build names do not need to be unique.

    • getOperatingSystem

      @Stability(Stable) @Nullable public String getOperatingSystem()
      The operating system that your game server binaries run on.

      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.

    • setOperatingSystem

      @Stability(Stable) public void setOperatingSystem(@Nullable String value)
      The operating system that your game server binaries run on.

      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.

    • getServerSdkVersion

      @Stability(Stable) @Nullable public String getServerSdkVersion()
      The Amazon GameLift Server SDK version used to develop your game server.

    • setServerSdkVersion

      @Stability(Stable) public void setServerSdkVersion(@Nullable String value)
      The Amazon GameLift Server SDK version used to develop your game server.

    • getStorageLocation

      @Stability(Stable) @Nullable public 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.

    • setStorageLocation

      @Stability(Stable) public void setStorageLocation(@Nullable IResolvable value)
      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.

    • setStorageLocation

      @Stability(Stable) public void setStorageLocation(@Nullable CfnBuild.StorageLocationProperty value)
      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

      @Stability(Stable) @Nullable public String getVersion()
      Version information that is associated with this build.

      Version strings do not need to be unique.

    • setVersion

      @Stability(Stable) public void setVersion(@Nullable String value)
      Version information that is associated with this build.

      Version strings do not need to be unique.