1. Packages
  2. AWS
  3. API Docs
  4. gamelift
  5. Build
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

aws.gamelift.Build

Explore with Pulumi AI

aws logo
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

    Provides an GameLift Build resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.gamelift.Build("test", {
        name: "example-build",
        operatingSystem: "WINDOWS_2012",
        storageLocation: {
            bucket: testAwsS3Bucket.id,
            key: testAwsS3Object.key,
            roleArn: testAwsIamRole.arn,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.gamelift.Build("test",
        name="example-build",
        operating_system="WINDOWS_2012",
        storage_location={
            "bucket": test_aws_s3_bucket["id"],
            "key": test_aws_s3_object["key"],
            "role_arn": test_aws_iam_role["arn"],
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/gamelift"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gamelift.NewBuild(ctx, "test", &gamelift.BuildArgs{
    			Name:            pulumi.String("example-build"),
    			OperatingSystem: pulumi.String("WINDOWS_2012"),
    			StorageLocation: &gamelift.BuildStorageLocationArgs{
    				Bucket:  pulumi.Any(testAwsS3Bucket.Id),
    				Key:     pulumi.Any(testAwsS3Object.Key),
    				RoleArn: pulumi.Any(testAwsIamRole.Arn),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.GameLift.Build("test", new()
        {
            Name = "example-build",
            OperatingSystem = "WINDOWS_2012",
            StorageLocation = new Aws.GameLift.Inputs.BuildStorageLocationArgs
            {
                Bucket = testAwsS3Bucket.Id,
                Key = testAwsS3Object.Key,
                RoleArn = testAwsIamRole.Arn,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.gamelift.Build;
    import com.pulumi.aws.gamelift.BuildArgs;
    import com.pulumi.aws.gamelift.inputs.BuildStorageLocationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new Build("test", BuildArgs.builder()
                .name("example-build")
                .operatingSystem("WINDOWS_2012")
                .storageLocation(BuildStorageLocationArgs.builder()
                    .bucket(testAwsS3Bucket.id())
                    .key(testAwsS3Object.key())
                    .roleArn(testAwsIamRole.arn())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:gamelift:Build
        properties:
          name: example-build
          operatingSystem: WINDOWS_2012
          storageLocation:
            bucket: ${testAwsS3Bucket.id}
            key: ${testAwsS3Object.key}
            roleArn: ${testAwsIamRole.arn}
    

    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: BuildArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Build(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              operating_system: Optional[str] = None,
              storage_location: Optional[BuildStorageLocationArgs] = None,
              name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              version: Optional[str] = None)
    func NewBuild(ctx *Context, name string, args BuildArgs, opts ...ResourceOption) (*Build, error)
    public Build(string name, BuildArgs args, CustomResourceOptions? opts = null)
    public Build(String name, BuildArgs args)
    public Build(String name, BuildArgs args, CustomResourceOptions options)
    
    type: aws: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.

    Constructor example

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

    var buildResource = new Aws.GameLift.Build("buildResource", new()
    {
        OperatingSystem = "string",
        StorageLocation = new Aws.GameLift.Inputs.BuildStorageLocationArgs
        {
            Bucket = "string",
            Key = "string",
            RoleArn = "string",
            ObjectVersion = "string",
        },
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Version = "string",
    });
    
    example, err := gamelift.NewBuild(ctx, "buildResource", &gamelift.BuildArgs{
    	OperatingSystem: pulumi.String("string"),
    	StorageLocation: &gamelift.BuildStorageLocationArgs{
    		Bucket:        pulumi.String("string"),
    		Key:           pulumi.String("string"),
    		RoleArn:       pulumi.String("string"),
    		ObjectVersion: pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Version: pulumi.String("string"),
    })
    
    var buildResource = new Build("buildResource", BuildArgs.builder()
        .operatingSystem("string")
        .storageLocation(BuildStorageLocationArgs.builder()
            .bucket("string")
            .key("string")
            .roleArn("string")
            .objectVersion("string")
            .build())
        .name("string")
        .tags(Map.of("string", "string"))
        .version("string")
        .build());
    
    build_resource = aws.gamelift.Build("buildResource",
        operating_system="string",
        storage_location={
            "bucket": "string",
            "key": "string",
            "role_arn": "string",
            "object_version": "string",
        },
        name="string",
        tags={
            "string": "string",
        },
        version="string")
    
    const buildResource = new aws.gamelift.Build("buildResource", {
        operatingSystem: "string",
        storageLocation: {
            bucket: "string",
            key: "string",
            roleArn: "string",
            objectVersion: "string",
        },
        name: "string",
        tags: {
            string: "string",
        },
        version: "string",
    });
    
    type: aws:gamelift:Build
    properties:
        name: string
        operatingSystem: string
        storageLocation:
            bucket: string
            key: string
            objectVersion: string
            roleArn: string
        tags:
            string: string
        version: string
    

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Build resource accepts the following input properties:

    OperatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    StorageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    Name string
    Name of the build
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Version string
    Version that is associated with this build.
    OperatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    StorageLocation BuildStorageLocationArgs
    Information indicating where your game build files are stored. See below.
    Name string
    Name of the build
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Version string
    Version that is associated with this build.
    operatingSystem String
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    name String
    Name of the build
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    version String
    Version that is associated with this build.
    operatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    name string
    Name of the build
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    version string
    Version that is associated with this build.
    operating_system str
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storage_location BuildStorageLocationArgs
    Information indicating where your game build files are stored. See below.
    name str
    Name of the build
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    version str
    Version that is associated with this build.
    operatingSystem String
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation Property Map
    Information indicating where your game build files are stored. See below.
    name String
    Name of the build
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    version String
    Version that is associated with this build.

    Outputs

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

    Arn string
    GameLift Build ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    GameLift Build ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    GameLift Build ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    GameLift Build ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    GameLift Build ARN.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    GameLift Build ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Build Resource

    Get an existing Build resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BuildState, opts?: CustomResourceOptions): Build
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            name: Optional[str] = None,
            operating_system: Optional[str] = None,
            storage_location: Optional[BuildStorageLocationArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            version: Optional[str] = None) -> Build
    func GetBuild(ctx *Context, name string, id IDInput, state *BuildState, opts ...ResourceOption) (*Build, error)
    public static Build Get(string name, Input<string> id, BuildState? state, CustomResourceOptions? opts = null)
    public static Build get(String name, Output<String> id, BuildState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    GameLift Build ARN.
    Name string
    Name of the build
    OperatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    StorageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    Tags Dictionary<string, string>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version that is associated with this build.
    Arn string
    GameLift Build ARN.
    Name string
    Name of the build
    OperatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    StorageLocation BuildStorageLocationArgs
    Information indicating where your game build files are stored. See below.
    Tags map[string]string
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Version string
    Version that is associated with this build.
    arn String
    GameLift Build ARN.
    name String
    Name of the build
    operatingSystem String
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    tags Map<String,String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version that is associated with this build.
    arn string
    GameLift Build ARN.
    name string
    Name of the build
    operatingSystem string
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation BuildStorageLocation
    Information indicating where your game build files are stored. See below.
    tags {[key: string]: string}
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version string
    Version that is associated with this build.
    arn str
    GameLift Build ARN.
    name str
    Name of the build
    operating_system str
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storage_location BuildStorageLocationArgs
    Information indicating where your game build files are stored. See below.
    tags Mapping[str, str]
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version str
    Version that is associated with this build.
    arn String
    GameLift Build ARN.
    name String
    Name of the build
    operatingSystem String
    Operating system that the game server binaries are built to run on. Valid values: WINDOWS_2012, AMAZON_LINUX, AMAZON_LINUX_2, WINDOWS_2016, AMAZON_LINUX_2023.
    storageLocation Property Map
    Information indicating where your game build files are stored. See below.
    tags Map<String>
    Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    version String
    Version that is associated with this build.

    Supporting Types

    BuildStorageLocation, BuildStorageLocationArgs

    Bucket string
    Name of your S3 bucket.
    Key string
    Name of the zip file containing your build files.
    RoleArn string
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    ObjectVersion string
    A specific version of the file. If not set, the latest version of the file is retrieved.
    Bucket string
    Name of your S3 bucket.
    Key string
    Name of the zip file containing your build files.
    RoleArn string
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    ObjectVersion string
    A specific version of the file. If not set, the latest version of the file is retrieved.
    bucket String
    Name of your S3 bucket.
    key String
    Name of the zip file containing your build files.
    roleArn String
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    objectVersion String
    A specific version of the file. If not set, the latest version of the file is retrieved.
    bucket string
    Name of your S3 bucket.
    key string
    Name of the zip file containing your build files.
    roleArn string
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    objectVersion string
    A specific version of the file. If not set, the latest version of the file is retrieved.
    bucket str
    Name of your S3 bucket.
    key str
    Name of the zip file containing your build files.
    role_arn str
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    object_version str
    A specific version of the file. If not set, the latest version of the file is retrieved.
    bucket String
    Name of your S3 bucket.
    key String
    Name of the zip file containing your build files.
    roleArn String
    ARN of the access role that allows Amazon GameLift to access your S3 bucket.
    objectVersion String
    A specific version of the file. If not set, the latest version of the file is retrieved.

    Import

    Using pulumi import, import GameLift Builds using the ID. For example:

    $ pulumi import aws:gamelift/build:Build example <build-id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi