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

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

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

aws-native.gamelift.getScript

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.97.0 published on Wednesday, Feb 21, 2024 by Pulumi

    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.

    Using getScript

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScript(args: GetScriptArgs, opts?: InvokeOptions): Promise<GetScriptResult>
    function getScriptOutput(args: GetScriptOutputArgs, opts?: InvokeOptions): Output<GetScriptResult>
    def get_script(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetScriptResult
    def get_script_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetScriptResult]
    func LookupScript(ctx *Context, args *LookupScriptArgs, opts ...InvokeOption) (*LookupScriptResult, error)
    func LookupScriptOutput(ctx *Context, args *LookupScriptOutputArgs, opts ...InvokeOption) LookupScriptResultOutput

    > Note: This function is named LookupScript in the Go SDK.

    public static class GetScript 
    {
        public static Task<GetScriptResult> InvokeAsync(GetScriptArgs args, InvokeOptions? opts = null)
        public static Output<GetScriptResult> Invoke(GetScriptInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetScriptResult> getScript(GetScriptArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:gamelift:getScript
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    A unique identifier for the Realtime script
    Id string
    A unique identifier for the Realtime script
    id String
    A unique identifier for the Realtime script
    id string
    A unique identifier for the Realtime script
    id str
    A unique identifier for the Realtime script
    id String
    A unique identifier for the Realtime script

    getScript Result

    The following output properties are available:

    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.
    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
    A unique identifier for the Realtime script
    Name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    StorageLocation Pulumi.AwsNative.GameLift.Outputs.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.
    Tags List<Pulumi.AwsNative.GameLift.Outputs.ScriptTag>
    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.
    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.
    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
    A unique identifier for the Realtime script
    Name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    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.
    Tags []ScriptTag
    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.
    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.
    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
    A unique identifier for the Realtime script
    name String
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    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.
    tags List<ScriptTag>
    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.
    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.
    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
    A unique identifier for the Realtime script
    name string
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    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.
    tags ScriptTag[]
    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.
    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.
    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
    A unique identifier for the Realtime script
    name str
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    storage_location 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.
    tags Sequence[ScriptTag]
    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.
    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.
    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
    A unique identifier for the Realtime script
    name String
    A descriptive label that is associated with a script. Script names do not need to be unique.
    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".
    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.
    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.

    Supporting Types

    ScriptS3Location

    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.

    ScriptTag

    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.
    Key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    Value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.
    key string
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    value string
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.
    key str
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    value str
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.
    key String
    The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length.
    value String
    The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length.

    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.97.0 published on Wednesday, Feb 21, 2024 by Pulumi