Script class

Provides an GameLift Script resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.gamelift.Script("example", {
    storageLocation: {
        bucket: exampleAwsS3Bucket.id,
        key: exampleAwsS3Object.key,
        roleArn: exampleAwsIamRole.arn,
    },
    name: "example-script",
});
import pulumi
import pulumi_aws as aws

example = aws.gamelift.Script("example",
    storage_location={
        "bucket": example_aws_s3_bucket["id"],
        "key": example_aws_s3_object["key"],
        "role_arn": example_aws_iam_role["arn"],
    },
    name="example-script")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.GameLift.Script("example", new()
    {
        StorageLocation = new Aws.GameLift.Inputs.ScriptStorageLocationArgs
        {
            Bucket = exampleAwsS3Bucket.Id,
            Key = exampleAwsS3Object.Key,
            RoleArn = exampleAwsIamRole.Arn,
        },
        Name = "example-script",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/gamelift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewScript(ctx, "example", &gamelift.ScriptArgs{
			StorageLocation: &gamelift.ScriptStorageLocationArgs{
				Bucket:  pulumi.Any(exampleAwsS3Bucket.Id),
				Key:     pulumi.Any(exampleAwsS3Object.Key),
				RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
			},
			Name: pulumi.String("example-script"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_gamelift_script" "example" {
  storage_location = {
    bucket   = exampleAwsS3Bucket.id
    key      = exampleAwsS3Object.key
    role_arn = exampleAwsIamRole.arn
  }
  name = "example-script"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.gamelift.Script;
import com.pulumi.aws.gamelift.ScriptArgs;
import com.pulumi.aws.gamelift.inputs.ScriptStorageLocationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = new Script("example", ScriptArgs.builder()
            .storageLocation(ScriptStorageLocationArgs.builder()
                .bucket(exampleAwsS3Bucket.id())
                .key(exampleAwsS3Object.key())
                .roleArn(exampleAwsIamRole.arn())
                .build())
            .name("example-script")
            .build());

    }
}
resources:
  example:
    type: aws:gamelift:Script
    properties:
      storageLocation:
        bucket: ${exampleAwsS3Bucket.id}
        key: ${exampleAwsS3Object.key}
        roleArn: ${exampleAwsIamRole.arn}
      name: example-script

Import

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

$ pulumi import aws:gamelift/script:Script example <script-id>

Constructors

Script(String name, {ScriptArgs? args, CustomResourceOptions? options})
Creates a new Script. name The Pulumi resource name. args Arguments used to configure this Script. The set of arguments for Script. options Resource options controlling this resource's behavior.
Script.reference(String urn)
Creates a typed reference to an existing Script resource.

Properties

arn ↔ Output<String>
GameLift Script ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the script
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storageLocation ↔ Output<ScriptStorageLocation>
Information indicating where your game script files are stored. See below.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
version ↔ Output<String?>
Version that is associated with this script.
latefinal
zipFile ↔ Output<String?>
A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ScriptState? state, CustomResourceOptions? options}) → Script
Gets an existing Script resource's state with the given name and id.