Class CfnAccessGrant.AccessGrantsLocationConfigurationProperty

The configuration options of the S3 Access Grants location.

Inheritance
object
CfnAccessGrant.AccessGrantsLocationConfigurationProperty
Inherited Members
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccessGrant.AccessGrantsLocationConfigurationProperty : CfnAccessGrant.IAccessGrantsLocationConfigurationProperty
Syntax (vb)
Public Class CfnAccessGrant.AccessGrantsLocationConfigurationProperty Implements CfnAccessGrant.IAccessGrantsLocationConfigurationProperty
Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var accessGrantsLocationConfigurationProperty = new AccessGrantsLocationConfigurationProperty {
                 S3SubPrefix = "s3SubPrefix"
             };

Synopsis

Constructors

AccessGrantsLocationConfigurationProperty()

The configuration options of the S3 Access Grants location.

Properties

S3SubPrefix

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

Constructors

AccessGrantsLocationConfigurationProperty()

The configuration options of the S3 Access Grants location.

public AccessGrantsLocationConfigurationProperty()
Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var accessGrantsLocationConfigurationProperty = new AccessGrantsLocationConfigurationProperty {
                 S3SubPrefix = "s3SubPrefix"
             };

Properties

S3SubPrefix

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

public string S3SubPrefix { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accessgrant-accessgrantslocationconfiguration.html#cfn-s3-accessgrant-accessgrantslocationconfiguration-s3subprefix

Implements