Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. gamelift
  5. Build

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.Build

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::GameLift::Build

    Create Build Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Build(name: string, args?: BuildArgs, opts?: CustomResourceOptions);
    @overload
def Build(resource_name: str,
          args: Optional[BuildArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Build(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None,
          operating_system: Optional[BuildOperatingSystem] = None,
          server_sdk_version: Optional[str] = None,
          storage_location: Optional[BuildStorageLocationArgs] = None,
          version: Optional[str] = None)
    func NewBuild(ctx *Context, name string, args *BuildArgs, opts ...ResourceOption) (*Build, error)
    public Build(string name, BuildArgs? args = null, CustomResourceOptions? opts = null)
    public Build(String name, BuildArgs args)
public Build(String name, BuildArgs args, CustomResourceOptions options)

    type: aws-native:gamelift:Build
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BuildArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BuildArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BuildArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BuildArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BuildArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const buildResource = new aws_native.gamelift.Build("buildResource", {
    name: "string",
    operatingSystem: aws_native.gamelift.BuildOperatingSystem.AmazonLinux,
    serverSdkVersion: "string",
    storageLocation: {
        bucket: "string",
        key: "string",
        roleArn: "string",
        objectVersion: "string",
    },
    version: "string",
});

    Coming soon!

    Build Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Build resource accepts the following input properties:

    Name string
    A descriptive label that is associated with a build. Build names do not need to be unique.
    OperatingSystem Pulumi.AwsNative.GameLift.BuildOperatingSystem
    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.
    ServerSdkVersion string
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    StorageLocation Pulumi.AwsNative.GameLift.Inputs.BuildStorageLocation
    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.
    Version string
    Version information that is associated with this build. Version strings do not need to be unique.
    Name string
    A descriptive label that is associated with a build. Build names do not need to be unique.
    OperatingSystem BuildOperatingSystem
    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.
    ServerSdkVersion string
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    StorageLocation BuildStorageLocationArgs
    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.
    Version string
    Version information that is associated with this build. Version strings do not need to be unique.
    name String
    A descriptive label that is associated with a build. Build names do not need to be unique.
    operatingSystem BuildOperatingSystem
    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.
    serverSdkVersion String
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    storageLocation BuildStorageLocation
    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.
    version String
    Version information that is associated with this build. Version strings do not need to be unique.
    name string
    A descriptive label that is associated with a build. Build names do not need to be unique.
    operatingSystem BuildOperatingSystem
    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.
    serverSdkVersion string
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    storageLocation BuildStorageLocation
    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.
    version string
    Version information that is associated with this build. Version strings do not need to be unique.
    name str
    A descriptive label that is associated with a build. Build names do not need to be unique.
    operating_system BuildOperatingSystem
    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.
    server_sdk_version str
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    storage_location BuildStorageLocationArgs
    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.
    version str
    Version information that is associated with this build. Version strings do not need to be unique.
    name String
    A descriptive label that is associated with a build. Build names do not need to be unique.
    operatingSystem "AMAZON_LINUX" | "AMAZON_LINUX_2" | "AMAZON_LINUX_2023" | "WINDOWS_2012" | "WINDOWS_2016"
    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.
    serverSdkVersion String
    A server SDK version you used when integrating your game server build with Amazon GameLift. By default Amazon GameLift sets this value to 4.0.2.
    storageLocation Property Map
    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.
    version String
    Version information that is associated with this build. Version strings do not need to be unique.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Build resource produces the following output properties:

    BuildId string
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    BuildId string
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    buildId String
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    id String
    The provider-assigned unique ID for this managed resource.
    buildId string
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    id string
    The provider-assigned unique ID for this managed resource.
    build_id str
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    id str
    The provider-assigned unique ID for this managed resource.
    buildId String
    A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BuildOperatingSystem, BuildOperatingSystemArgs

    AmazonLinux
    AMAZON_LINUX
    AmazonLinux2
    AMAZON_LINUX_2
    AmazonLinux2023
    AMAZON_LINUX_2023
    Windows2012
    WINDOWS_2012
    Windows2016
    WINDOWS_2016
    BuildOperatingSystemAmazonLinux
    AMAZON_LINUX
    BuildOperatingSystemAmazonLinux2
    AMAZON_LINUX_2
    BuildOperatingSystemAmazonLinux2023
    AMAZON_LINUX_2023
    BuildOperatingSystemWindows2012
    WINDOWS_2012
    BuildOperatingSystemWindows2016
    WINDOWS_2016
    AmazonLinux
    AMAZON_LINUX
    AmazonLinux2
    AMAZON_LINUX_2
    AmazonLinux2023
    AMAZON_LINUX_2023
    Windows2012
    WINDOWS_2012
    Windows2016
    WINDOWS_2016
    AmazonLinux
    AMAZON_LINUX
    AmazonLinux2
    AMAZON_LINUX_2
    AmazonLinux2023
    AMAZON_LINUX_2023
    Windows2012
    WINDOWS_2012
    Windows2016
    WINDOWS_2016
    AMAZON_LINUX
    AMAZON_LINUX
    AMAZON_LINUX2
    AMAZON_LINUX_2
    AMAZON_LINUX2023
    AMAZON_LINUX_2023
    WINDOWS2012
    WINDOWS_2012
    WINDOWS2016
    WINDOWS_2016
    "AMAZON_LINUX"
    AMAZON_LINUX
    "AMAZON_LINUX_2"
    AMAZON_LINUX_2
    "AMAZON_LINUX_2023"
    AMAZON_LINUX_2023
    "WINDOWS_2012"
    WINDOWS_2012
    "WINDOWS_2016"
    WINDOWS_2016

    BuildStorageLocation, BuildStorageLocationArgs

    Bucket string
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    Key string
    The name of the zip file that contains the build files or script files.
    RoleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    ObjectVersion string
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.
    Bucket string
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    Key string
    The name of the zip file that contains the build files or script files.
    RoleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    ObjectVersion string
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.
    bucket String
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    key String
    The name of the zip file that contains the build files or script files.
    roleArn String
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    objectVersion String
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.
    bucket string
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    key string
    The name of the zip file that contains the build files or script files.
    roleArn string
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    objectVersion string
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.
    bucket str
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    key str
    The name of the zip file that contains the build files or script files.
    role_arn str
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    object_version str
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.
    bucket String
    An Amazon S3 bucket identifier. This is the name of the S3 bucket.
    key String
    The name of the zip file that contains the build files or script files.
    roleArn String
    The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.
    objectVersion String
    The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from your S3 bucket. To retrieve a specific version of the file, provide an object version. To retrieve the latest version of the file, do not set this parameter.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native