interface GranteeProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.S3.CfnAccessGrant.GranteeProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnAccessGrant_GranteeProperty |
 Java | software.amazon.awscdk.services.s3.CfnAccessGrant.GranteeProperty |
 Python | aws_cdk.aws_s3.CfnAccessGrant.GranteeProperty |
 TypeScript | aws-cdk-lib » aws_s3 » CfnAccessGrant » 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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const granteeProperty: s3.CfnAccessGrant.GranteeProperty = {
granteeIdentifier: 'granteeIdentifier',
granteeType: 'granteeType',
};
Properties
| Name | Type | Description |
|---|---|---|
| grantee | string | The unique identifier of the Grantee . |
| grantee | string | The type of the grantee to which access has been granted. It can be one of the following values:. |
granteeIdentifier
Type:
string
The unique identifier of the Grantee .
If the grantee type is IAM , the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . You can obtain this UUID from your AWS IAM Identity Center instance.
granteeType
Type:
string
The type of the grantee to which access has been granted. It can be one of the following values:.
IAM- An IAM user or role.DIRECTORY_USER- Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.DIRECTORY_GROUP- Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.