Interface ICfnScriptProps

Properties for defining a CfnScript.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnScriptProps

Syntax (vb)

Public Interface ICfnScriptProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html

ExampleMetadata: fixture=_generated

Examples

// 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",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Version = "version"
             };

Synopsis

Properties

Name	A descriptive label that is associated with a script.
StorageLocation	The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
Tags	A list of labels to assign to the new script resource.
Version	The version that is associated with a build or script.

Properties

Name

A descriptive label that is associated with a script.

string? Name { get; }

Property Value

string

Remarks

Script names do not need to be unique.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-name

StorageLocation

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

object StorageLocation { get; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-storagelocation

Type union: either IResolvable or CfnScript.IS3LocationProperty

Tags

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

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-tags

Version

The version that is associated with a build or script.

string? Version { get; }

Property Value

string

Remarks

Version strings do not need to be unique.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-script.html#cfn-gamelift-script-version