Package software.amazon.awscdk.services.s3

Class CfnAccessGrant.Builder

java.lang.Object

software.amazon.awscdk.services.s3.CfnAccessGrant.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessGrant>

Enclosing class:

CfnAccessGrant

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

A fluent builder for CfnAccessGrant.

Method Summary

Modifier and Type	Method	Description
CfnAccessGrant.Builder	accessGrantsLocationConfiguration(IResolvable accessGrantsLocationConfiguration)	The configuration options of the grant location.
CfnAccessGrant.Builder	accessGrantsLocationConfiguration(CfnAccessGrant.AccessGrantsLocationConfigurationProperty accessGrantsLocationConfiguration)	The configuration options of the grant location.
CfnAccessGrant.Builder	accessGrantsLocationId(String accessGrantsLocationId)	The ID of the registered location to which you are granting access.
CfnAccessGrant.Builder	applicationArn(String applicationArn)	The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.
CfnAccessGrant	build()
static CfnAccessGrant.Builder	create(software.constructs.Construct scope, String id)
CfnAccessGrant.Builder	grantee(IResolvable grantee)	The user, group, or role to which you are granting access.
CfnAccessGrant.Builder	grantee(CfnAccessGrant.GranteeProperty grantee)	The user, group, or role to which you are granting access.
CfnAccessGrant.Builder	permission(String permission)	The type of access that you are granting to your S3 data, which can be set to one of the following values: - READ – Grant read-only access to the S3 data.
CfnAccessGrant.Builder	s3PrefixType(String s3PrefixType)	The type of S3SubPrefix .
CfnAccessGrant.Builder	tags(List<? extends CfnTag> tags)	The AWS resource tags that you are adding to the access grant.

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 CfnAccessGrant.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 CfnAccessGrant.Builder.

accessGrantsLocationId

@Stability(Stable)
public CfnAccessGrant.Builder accessGrantsLocationId(String accessGrantsLocationId)

The ID of the registered location to which you are granting access.

S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

Parameters:

accessGrantsLocationId - The ID of the registered location to which you are granting access. This parameter is required.

Returns:

this

See Also:

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

grantee

@Stability(Stable)
public CfnAccessGrant.Builder grantee(IResolvable grantee)

The user, group, or role to which you are granting access.

You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

Parameters:

grantee - The user, group, or role to which you are granting access. This parameter is required.

Returns:

this

See Also:

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

grantee

@Stability(Stable)
public CfnAccessGrant.Builder grantee(CfnAccessGrant.GranteeProperty grantee)

The user, group, or role to which you are granting access.

You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

Parameters:

grantee - The user, group, or role to which you are granting access. This parameter is required.

Returns:

this

See Also:

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

permission

@Stability(Stable)
public CfnAccessGrant.Builder permission(String permission)

The type of access that you are granting to your S3 data, which can be set to one of the following values: - READ – Grant read-only access to the S3 data.

• WRITE – Grant write-only access to the S3 data.
• READWRITE – Grant both read and write access to the S3 data.

Parameters:

permission - The type of access that you are granting to your S3 data, which can be set to one of the following values: - READ – Grant read-only access to the S3 data. This parameter is required.

Returns:

this

See Also:

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

accessGrantsLocationConfiguration

@Stability(Stable)
public CfnAccessGrant.Builder accessGrantsLocationConfiguration(IResolvable accessGrantsLocationConfiguration)

The configuration options of the grant location.

The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

Parameters:

accessGrantsLocationConfiguration - The configuration options of the grant location. This parameter is required.

Returns:

this

See Also:

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

accessGrantsLocationConfiguration

@Stability(Stable)
public CfnAccessGrant.Builder accessGrantsLocationConfiguration(CfnAccessGrant.AccessGrantsLocationConfigurationProperty accessGrantsLocationConfiguration)

The configuration options of the grant location.

The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

Parameters:

accessGrantsLocationConfiguration - The configuration options of the grant location. This parameter is required.

Returns:

this

See Also:

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

applicationArn

@Stability(Stable)
public CfnAccessGrant.Builder applicationArn(String applicationArn)

The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.

If the grant includes an application ARN, the grantee can only access the S3 data through this application.

Parameters:

applicationArn - The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance. This parameter is required.

Returns:

this

See Also:

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

s3PrefixType

@Stability(Stable)
public CfnAccessGrant.Builder s3PrefixType(String s3PrefixType)

The type of S3SubPrefix .

The only possible value is Object . Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

Parameters:

s3PrefixType - The type of S3SubPrefix . This parameter is required.

Returns:

this

See Also:

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

tags

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

The AWS resource tags that you are adding to the access grant.

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 access grant. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccessGrant build()

Specified by:

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

Returns:

a newly built instance of CfnAccessGrant.