Package software.amazon.awscdk.services.gamelift

Class CfnBuild

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnBuild
All Implemented Interfaces:
IInspectable, ITaggableV2, IBuildRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:39.237Z") @Stability(Stable) public class CfnBuild extends CfnResource implements IInspectable, IBuildRef, ITaggableV2
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())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .version("version")
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnBuildProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnBuild

      @Stability(Stable) public CfnBuild(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromBuildArn

      @Stability(Stable) @NotNull public static IBuildRef fromBuildArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IBuildRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromBuildId

      @Stability(Stable) @NotNull public static IBuildRef fromBuildId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String buildId)
      Creates a new IBuildRef from a buildId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      buildId - This parameter is required.

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

    • getAttrBuildArn

      @Stability(Stable) @NotNull public String getAttrBuildArn()
      The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift build ARN, the resource ID matches the BuildId value.

    • getAttrBuildId

      @Stability(Stable) @NotNull public String getAttrBuildId()
      A unique identifier for the build.

    • getBuildRef

      @Stability(Stable) @NotNull public BuildReference getBuildRef()
      A reference to a Build resource.
      Specified by:
      getBuildRef in interface IBuildRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

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

    • setName

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

    • getOperatingSystem

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

    • setOperatingSystem

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

    • getServerSdkVersion

      @Stability(Stable) @Nullable public String getServerSdkVersion()
      A server SDK version you used when integrating your game server build with Amazon GameLift Servers.

    • setServerSdkVersion

      @Stability(Stable) public void setServerSdkVersion(@Nullable String value)
      A server SDK version you used when integrating your game server build with Amazon GameLift Servers.

    • getStorageLocation

      @Stability(Stable) @Nullable public Object getStorageLocation()
      Information indicating where your game build files are stored.

      Returns union: either IResolvable or CfnBuild.StorageLocationProperty

    • setStorageLocation

      @Stability(Stable) public void setStorageLocation(@Nullable IResolvable value)
      Information indicating where your game build files are stored.

    • setStorageLocation

      @Stability(Stable) public void setStorageLocation(@Nullable CfnBuild.StorageLocationProperty value)
      Information indicating where your game build files are stored.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getVersion

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

    • setVersion

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