interface CfnScriptProps

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnScriptProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnScriptProps`
Java	`software.amazon.awscdk.services.gamelift.CfnScriptProps`
Python	`aws_cdk.aws_gamelift.CfnScriptProps`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnScriptProps`

Properties for defining a CfnScript.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnScriptProps: gamelift.CfnScriptProps = {
  storageLocation: {
    bucket: 'bucket',
    key: 'key',
    roleArn: 'roleArn',

    // the properties below are optional
    objectVersion: 'objectVersion',
  },

  // the properties below are optional
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  version: 'version',
};

Properties

Name	Type	Description
storageLocation	`IResolvable` `\|` `S3LocationProperty`	The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
name?	`string`	A descriptive label that is associated with a script.
tags?	`CfnTag[]`	A list of labels to assign to the new script resource.
version?	`string`	The version that is associated with a build or script.

storageLocation

Type: IResolvable | S3LocationProperty

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?

Type: string (optional)

A descriptive label that is associated with a script.

Script names do not need to be unique.

tags?

Type: CfnTag[] (optional)

A list of labels to assign to the new script resource.

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

version?

Type: string (optional)

The version that is associated with a build or script.

Version strings do not need to be unique.