class CfnAccessGrantsLocationPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3.Mixins.CfnAccessGrantsLocationPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3/mixins#CfnAccessGrantsLocationPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.s3.mixins.CfnAccessGrantsLocationPropsMixin
Python	aws_cdk.mixins_preview.aws_s3.mixins.CfnAccessGrantsLocationPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_s3 » mixins » CfnAccessGrantsLocationPropsMixin

Implements IMixin

Extends Mixin

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 . 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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as s3_mixins } from '@aws-cdk/mixins-preview/aws-s3';
const cfnAccessGrantsLocationPropsMixin = new s3_mixins.CfnAccessGrantsLocationPropsMixin({
  iamRoleArn: 'iamRoleArn',
  locationScope: 'locationScope',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAccessGrantsLocationPropsMixin(props: CfnAccessGrantsLocationMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnAccessGrantsLocationMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::S3::AccessGrantsLocation.

Properties

Name	Type	Description
props	CfnAccessGrantsLocationMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAccessGrantsLocationMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.