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

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

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.Script

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::GameLift::Script resource creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

    Create Script Resource

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

    Constructor syntax

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

@overload
def Script(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           storage_location: Optional[ScriptS3LocationArgs] = None,
           name: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           version: Optional[str] = None)
    func NewScript(ctx *Context, name string, args ScriptArgs, opts ...ResourceOption) (*Script, error)
    public Script(string name, ScriptArgs args, CustomResourceOptions? opts = null)
    public Script(String name, ScriptArgs args)
public Script(String name, ScriptArgs args, CustomResourceOptions options)

    type: aws-native:gamelift:Script
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 ScriptArgs
    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 ScriptArgs
    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 ScriptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScriptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScriptArgs
    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 scriptResource = new aws_native.gamelift.Script("scriptResource", {
    storageLocation: {
        bucket: "string",
        key: "string",
        roleArn: "string",
        objectVersion: "string",
    },
    name: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    version: "string",
});

    Coming soon!

    Script 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 Script resource accepts the following input properties:

    StorageLocation Pulumi.AwsNative.GameLift.Inputs.ScriptS3Location
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    Name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Version string
    The version that is associated with a script. Version strings do not need to be unique.
    StorageLocation ScriptS3LocationArgs
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    Name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    Version string
    The version that is associated with a script. Version strings do not need to be unique.
    storageLocation ScriptS3Location
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    name String
    A descriptive label that is associated with a script. Script names do not need to be unique.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    version String
    The version that is associated with a script. Version strings do not need to be unique.
    storageLocation ScriptS3Location
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    version string
    The version that is associated with a script. Version strings do not need to be unique.
    storage_location ScriptS3LocationArgs
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    name str
    A descriptive label that is associated with a script. Script names do not need to be unique.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    version str
    The version that is associated with a script. Version strings do not need to be unique.
    storageLocation Property Map
    The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
    name String
    A descriptive label that is associated with a script. Script names do not need to be unique.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    version String
    The version that is associated with a script. Version strings do not need to be unique.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    AwsId string
    A unique identifier for the Realtime script
    CreationTime string
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    Id string
    The provider-assigned unique ID for this managed resource.
    SizeOnDisk int
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    Arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    AwsId string
    A unique identifier for the Realtime script
    CreationTime string
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    Id string
    The provider-assigned unique ID for this managed resource.
    SizeOnDisk int
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    arn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    awsId String
    A unique identifier for the Realtime script
    creationTime String
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    id String
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk Integer
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    awsId string
    A unique identifier for the Realtime script
    creationTime string
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    id string
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk number
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    arn str
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    aws_id str
    A unique identifier for the Realtime script
    creation_time str
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    id str
    The provider-assigned unique ID for this managed resource.
    size_on_disk int
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".
    arn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the Id value.
    awsId String
    A unique identifier for the Realtime script
    creationTime String
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    id String
    The provider-assigned unique ID for this managed resource.
    sizeOnDisk Number
    The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

    Supporting Types

    ScriptS3Location, ScriptS3LocationArgs

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

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.104.0 published on Tuesday, Apr 30, 2024 by Pulumi
    pulumi/pulumi-aws-native