Package software.amazon.awscdk.services.s3

Interface CfnAccessGrant.AccessGrantsLocationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnAccessGrant

@Stability(Stable)
public static interface CfnAccessGrant.AccessGrantsLocationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration options of the S3 Access Grants location.

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

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.s3.*;
 AccessGrantsLocationConfigurationProperty accessGrantsLocationConfigurationProperty = AccessGrantsLocationConfigurationProperty.builder()
         .s3SubPrefix("s3SubPrefix")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder	builder()
String	getS3SubPrefix()	The S3SubPrefix is appended to the location scope creating the grant scope.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3SubPrefix

@Stability(Stable)
@NotNull
String getS3SubPrefix()

The S3SubPrefix is appended to the location scope creating the grant scope.

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.

See Also:

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

builder

@Stability(Stable)
static CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder builder()

Returns:

a CfnAccessGrant.AccessGrantsLocationConfigurationProperty.Builder of CfnAccessGrant.AccessGrantsLocationConfigurationProperty