CfnScriptProps Struct
Properties for defining a CfnScript.
| Source | |
|---|---|
| Type last changed |
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',
};
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_gamelift as gamelift
cfn_script_props = gamelift.CfnScriptProps(
storage_location=gamelift.CfnScript.S3LocationProperty(
bucket="bucket",
key="key",
role_arn="roleArn",
# the properties below are optional
object_version="objectVersion"
),
# the properties below are optional
name="name",
node_js_version="nodeJsVersion",
tags=[CfnTag(
key="key",
value="value"
)],
version="version"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.gamelift.*;
CfnScriptProps cfnScriptProps = CfnScriptProps.builder()
.storageLocation(S3LocationProperty.builder()
.bucket("bucket")
.key("key")
.roleArn("roleArn")
// the properties below are optional
.objectVersion("objectVersion")
.build())
// the properties below are optional
.name("name")
.nodeJsVersion("nodeJsVersion")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.version("version")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnScriptProps = new CfnScriptProps {
StorageLocation = new S3LocationProperty {
Bucket = "bucket",
Key = "key",
RoleArn = "roleArn",
// the properties below are optional
ObjectVersion = "objectVersion"
},
// the properties below are optional
Name = "name",
NodeJsVersion = "nodeJsVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Version = "version"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnScriptProps := &CfnScriptProps{
StorageLocation: &S3LocationProperty{
Bucket: jsii.String("bucket"),
Key: jsii.String("key"),
RoleArn: jsii.String("roleArn"),
// the properties below are optional
ObjectVersion: jsii.String("objectVersion"),
},
// the properties below are optional
Name: jsii.String("name"),
NodeJsVersion: jsii.String("nodeJsVersion"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Version: jsii.String("version"),
}
Properties
Script names do not need to be unique.
nodeJsVersionoptionalstringnode_js_versionoptionalstrnodeJsVersionoptionalStringNodeJsVersionoptionalstringNodeJsVersionoptional*string #storageLocationIResolvable | CfnScript.S3LocationPropertystorage_locationtyping.Union[IResolvable, S3LocationProperty]storageLocationIResolvableStorageLocationIResolvableStorageLocationinterface{} required #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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #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.
versionoptionalstringversionoptionalstrversionoptionalStringVersionoptionalstringVersionoptional*string #Version strings do not need to be unique.