software.amazon.awscdk.services.gamelift

Interface CfnScriptProps

All Known Implementing Classes:

CfnScriptProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:32.576Z")
public interface 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 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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnScriptProps.Builder A builder for CfnScriptProps
static class	CfnScriptProps.Jsii$Proxy An implementation for CfnScriptProps

Method Summary

Modifier and Type	Method and Description
static CfnScriptProps.Builder	builder()
default java.lang.String	getName() A descriptive label that is associated with a script.
java.lang.Object	getStorageLocation() The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored.
default java.util.List<CfnTag>	getTags() A list of labels to assign to the new script resource.
default java.lang.String	getVersion() The version that is associated with a build or script.

Method Detail

getStorageLocation

java.lang.Object getStorageLocation()

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.

getName

default java.lang.String getName()

A descriptive label that is associated with a script.

Script names do not need to be unique.

getTags

default java.util.List<CfnTag> getTags()

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.

getVersion

default java.lang.String getVersion()

The version that is associated with a build or script.

Version strings do not need to be unique.

builder

static CfnScriptProps.Builder builder()

Returns:

a CfnScriptProps.Builder of CfnScriptProps