aws-cdk-lib.aws_gamelift.CfnScriptProps

CfnScriptProps Struct

Properties for defining a CfnScript.

Source

Generated code

Type last changed

v2.235.0 · 15 Jan 2026

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',
  nodeJsVersion: 'nodeJsVersion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  version: 'version',
};

Properties

namestringnamestrnameStringNamestringName*string#

A descriptive label that is associated with a script.

Script names do not need to be unique.

nodeJsVersionstringnode_js_versionstrnodeJsVersionStringNodeJsVersionstringNodeJsVersion*string#

The Node.js version used for execution of the Realtime script.

storageLocationIResolvable | CfnScript.S3LocationPropertystorage_locationtyping.Union[IResolvable, S3LocationProperty]storageLocationIResolvableStorageLocationIResolvableStorageLocationinterface{}required#

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.

notes

The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers 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 Servers 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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

notes

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.

versionstringversionstrversionStringVersionstringVersion*string#

The version that is associated with a build or script.

Version strings do not need to be unique.

Used as props by

• CfnScript