Package software.amazon.awscdk.services.s3

Class CfnAccessGrantsLocation.Builder

java.lang.Object

software.amazon.awscdk.services.s3.CfnAccessGrantsLocation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessGrantsLocation>

Enclosing class:

CfnAccessGrantsLocation

@Stability(Stable)
public static final class CfnAccessGrantsLocation.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccessGrantsLocation>

A fluent builder for CfnAccessGrantsLocation.

Method Summary

Modifier and Type	Method	Description
CfnAccessGrantsLocation	build()
static CfnAccessGrantsLocation.Builder	create(software.constructs.Construct scope, String id)
CfnAccessGrantsLocation.Builder	iamRoleArn(String iamRoleArn)	The Amazon Resource Name (ARN) of the IAM role for the registered location.
CfnAccessGrantsLocation.Builder	locationScope(String locationScope)	The S3 URI path to the location that you are registering.
CfnAccessGrantsLocation.Builder	tags(List<? extends CfnTag> tags)	The AWS resource tags that you are adding to the S3 Access Grants location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccessGrantsLocation.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAccessGrantsLocation.Builder.

iamRoleArn

@Stability(Stable)
public CfnAccessGrantsLocation.Builder iamRoleArn(String iamRoleArn)

The Amazon Resource Name (ARN) of the IAM role for the registered location.

S3 Access Grants assumes this role to manage access to the registered location.

Parameters:

iamRoleArn - The Amazon Resource Name (ARN) of the IAM role for the registered location. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-iamrolearn

locationScope

@Stability(Stable)
public CfnAccessGrantsLocation.Builder locationScope(String locationScope)

The S3 URI path to the location that you are registering.

The location scope can be the default S3 location s3:// , the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

Parameters:

locationScope - The S3 URI path to the location that you are registering. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-locationscope

tags

@Stability(Stable)
public CfnAccessGrantsLocation.Builder tags(List<? extends CfnTag> tags)

The AWS resource tags that you are adding to the S3 Access Grants location.

Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Parameters:

tags - The AWS resource tags that you are adding to the S3 Access Grants location. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-tags

build

@Stability(Stable)
public CfnAccessGrantsLocation build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccessGrantsLocation>

Returns:

a newly built instance of CfnAccessGrantsLocation.