AWS::S3::AccessGrantsLocationCfnAccessGrantsLocation
The `AWS::S3::AccessGrantsLocation` resource creates the S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following: - The default S3 location `s3://` - A bucket - `S3://<bucket-name>` - A bucket and prefix - `S3://<bucket-name>/<prefix>` When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role [using a policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-grants-location.html) . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications. - **Permissions** - You must have the `s3:CreateAccessGrantsLocation` permission to use this resource. - **Additional Permissions** - You must also have the following permission for the specified IAM role: `iam:PassRole`
Import
import { CfnAccessGrantsLocation } from 'aws-cdk-lib/aws-s3';Or use the module namespace:
import * as s3 from 'aws-cdk-lib/aws-s3';
// s3.CfnAccessGrantsLocationProperties
Configuration passed to the constructor as CfnAccessGrantsLocationProps.
iamRoleArnRequiredstringThe 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.
locationScopeRequiredstringThe 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.
tagsOptionalCfnTag[]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.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the Amazon S3 Cheat Sheet
Everything you need to know about Amazon S3 on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-s3AWS::S3::AccessGrantsLocation