Package software.amazon.awscdk.cfnpropertymixins.services.s3

Class CfnAccessGrantsLocationPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3.CfnAccessGrantsLocationPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:33.360Z") @Stability(Stable) public class CfnAccessGrantsLocationPropsMixin extends Mixin implements software.constructs.IMixin
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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.s3.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAccessGrantsLocationPropsMixin cfnAccessGrantsLocationPropsMixin = CfnAccessGrantsLocationPropsMixin.Builder.create(CfnAccessGrantsLocationMixinProps.builder()
         .iamRoleArn("iamRoleArn")
         .locationScope("locationScope")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnAccessGrantsLocationPropsMixin

      protected CfnAccessGrantsLocationPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAccessGrantsLocationPropsMixin

      protected CfnAccessGrantsLocationPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAccessGrantsLocationPropsMixin

      @Stability(Stable) public CfnAccessGrantsLocationPropsMixin(@NotNull CfnAccessGrantsLocationMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3::AccessGrantsLocation.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnAccessGrantsLocationPropsMixin

      @Stability(Stable) public CfnAccessGrantsLocationPropsMixin(@NotNull CfnAccessGrantsLocationMixinProps props)
      Create a mixin to apply properties to AWS::S3::AccessGrantsLocation.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnAccessGrantsLocationMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()