Package software.amazon.awscdk.services.gamelift

Interface CfnScript.S3LocationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnScript.S3LocationProperty.Jsii$Proxy

Enclosing class:

CfnScript

@Stability(Stable)
public static interface CfnScript.S3LocationProperty
extends software.amazon.jsii.JsiiSerializable

The location in Amazon S3 where build or script files can be stored for access by Amazon GameLift.

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.*;
 S3LocationProperty s3LocationProperty = S3LocationProperty.builder()
         .bucket("bucket")
         .key("key")
         .roleArn("roleArn")
         // the properties below are optional
         .objectVersion("objectVersion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnScript.S3LocationProperty.Builder	builder()
String	getBucket()	An Amazon S3 bucket identifier.
String	getKey()	The name of the zip file that contains the build files or script files.
default String	getObjectVersion()	The version of the file, if object versioning is turned on for the bucket.
String	getRoleArn()	The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access the S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

An Amazon S3 bucket identifier. Thename of the S3 bucket.

Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot (.).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-bucket

getKey

@Stability(Stable)
@NotNull
String getKey()

The name of the zip file that contains the build files or script files.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-key

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access the S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-rolearn

getObjectVersion

@Stability(Stable)
@Nullable
default String getObjectVersion()

The version of the file, if object versioning is turned on for the bucket.

Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html#cfn-gamelift-script-s3location-objectversion

builder

@Stability(Stable)
static CfnScript.S3LocationProperty.Builder builder()

Returns:

a CfnScript.S3LocationProperty.Builder of CfnScript.S3LocationProperty