Package software.amazon.awscdk.services.s3

Class CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccessGrant.AccessGrantsLocationConfigurationProperty>

Enclosing interface:

CfnAccessGrant.AccessGrantsLocationConfigurationProperty

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

A builder for CfnAccessGrant.AccessGrantsLocationConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAccessGrant.AccessGrantsLocationConfigurationProperty	build()	Builds the configured instance.
CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder	s3SubPrefix(String s3SubPrefix)	Sets the value of CfnAccessGrant.AccessGrantsLocationConfigurationProperty.getS3SubPrefix()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

s3SubPrefix

@Stability(Stable)
public CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder s3SubPrefix(String s3SubPrefix)

Sets the value of CfnAccessGrant.AccessGrantsLocationConfigurationProperty.getS3SubPrefix()

Parameters:

s3SubPrefix - The S3SubPrefix is appended to the location scope creating the grant scope. This parameter is required. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3:// , the S3SubPrefx can be a <bucket-name>/* , so the full grant scope path would be s3://<bucket-name>/* . Or the S3SubPrefx can be <bucket-name>/<prefix-name>* , so the full grant scope path would be s3://<bucket-name>/<prefix-name>* .

If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.

Returns:

this

build

@Stability(Stable)
public CfnAccessGrant.AccessGrantsLocationConfigurationProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAccessGrant.AccessGrantsLocationConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided