L1 ConstructAWS::S3::AccessGrant

CfnAccessGrant

The `AWS::S3::AccessGrant` resource creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the [AWS::S3::AccessGrantsInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantsinstance.html) . You must also have registered at least one S3 data location in your S3 Access Grants instance using [AWS::S3::AccessGrantsLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html) . - **Permissions** - You must have the `s3:CreateAccessGrant` permission to use this resource. - **Additional Permissions** - For any directory identity - `sso:DescribeInstance` and `sso:DescribeApplication` For directory users - `identitystore:DescribeUser` For directory groups - `identitystore:DescribeGroup`

Import

import { CfnAccessGrant } from 'aws-cdk-lib/aws-s3';

Or use the module namespace:

import * as s3 from 'aws-cdk-lib/aws-s3';
// s3.CfnAccessGrant

Properties

Configuration passed to the constructor as CfnAccessGrantProps.

accessGrantsLocationIdRequired

string

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID `default` to the default location `s3://` and assigns an auto-generated ID to other locations that you register.

granteeRequired

IResolvable | GranteeProperty

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

permissionRequired

string

The type of access that you are granting to your S3 data, which can be set to one of the following values: - `READ` – Grant read-only access to the S3 data. - `WRITE` – Grant write-only access to the S3 data. - `READWRITE` – Grant both read and write access to the S3 data.

accessGrantsLocationConfigurationOptional

IResolvable | AccessGrantsLocationConfigurationProperty

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the `S3SubPrefix` field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

applicationArnOptional

string

The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

s3PrefixTypeOptional

string

The type of `S3SubPrefix` . The only possible value is `Object` . Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

tagsOptional

CfnTag[]

The AWS resource tags that you are adding to the access grant. 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.

AWS::S3::AccessGrantView in CloudFormation Explorer

Get the Amazon S3 Cheat Sheet

Everything you need to know about Amazon S3 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)

Moduleaws-s3

CFN TypeAWS::S3::AccessGrant

Properties7

Related Constructs

Explore This Service

External Links

CDK API Documentation