Class: AWSCDK::S3::CfnAccessGrant::AccessGrantsLocationConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3::CfnAccessGrant::AccessGrantsLocationConfigurationProperty

Defined in:

s3/cfn_access_grant.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #s3_sub_prefix ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(s3_sub_prefix:) ⇒ AccessGrantsLocationConfigurationProperty constructor

  A new instance of AccessGrantsLocationConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(s3_sub_prefix:) ⇒ AccessGrantsLocationConfigurationProperty

Returns a new instance of AccessGrantsLocationConfigurationProperty.

Parameters:

• s3_sub_prefix (String) —

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

# File 's3/cfn_access_grant.rb', line 628

def initialize(s3_sub_prefix:)
  @s3_sub_prefix = s3_sub_prefix
  Jsii::Type.check_type(@s3_sub_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3SubPrefix")
end

Instance Attribute Details

#s3_sub_prefix ⇒ String (readonly)

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.

Returns:

• (String)

See Also:

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

# File 's3/cfn_access_grant.rb', line 641

def s3_sub_prefix
  @s3_sub_prefix
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3/cfn_access_grant.rb', line 643

def self.jsii_properties
  {
    :s3_sub_prefix => "s3SubPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3/cfn_access_grant.rb', line 649

def to_jsii
  result = {}
  result.merge!({
    "s3SubPrefix" => @s3_sub_prefix,
  })
  result.compact
end