CfnAccessGrantsLocationProps

class aws_cdk.aws_s3.CfnAccessGrantsLocationProps(*, iam_role_arn=None, location_scope=None, tags=None)

Bases: object

Properties for defining a CfnAccessGrantsLocation.

Parameters:

  • iam_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

  • location_scope (Optional[str]) – The S3 URI path to the location that you are registering. The location scope can be the default S3 location s3:// , the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The AWS resource tags that you are adding to the S3 Access Grants location. 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3

cfn_access_grants_location_props = s3.CfnAccessGrantsLocationProps(
    iam_role_arn="iamRoleArn",
    location_scope="locationScope",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

iam_role_arn

The Amazon Resource Name (ARN) of the IAM role for the registered location.

S3 Access Grants assumes this role to manage access to the registered location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-iamrolearn

location_scope

The S3 URI path to the location that you are registering.

The location scope can be the default S3 location s3:// , the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-locationscope

tags

The AWS resource tags that you are adding to the S3 Access Grants location.

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.

See:

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