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

Class CfnAccessGrantPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.s3.CfnAccessGrantPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-19T12:55:25.960Z") @Stability(Stable) public class CfnAccessGrantPropsMixin extends Mixin implements software.constructs.IMixin
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 . You must also have registered at least one S3 data location in your S3 Access Grants instance using AWS::S3::AccessGrantsLocation .

  • 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

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;
 CfnAccessGrantPropsMixin cfnAccessGrantPropsMixin = CfnAccessGrantPropsMixin.Builder.create(CfnAccessGrantMixinProps.builder()
         .accessGrantsLocationConfiguration(AccessGrantsLocationConfigurationProperty.builder()
                 .s3SubPrefix("s3SubPrefix")
                 .build())
         .accessGrantsLocationId("accessGrantsLocationId")
         .applicationArn("applicationArn")
         .grantee(GranteeProperty.builder()
                 .granteeIdentifier("granteeIdentifier")
                 .granteeType("granteeType")
                 .build())
         .permission("permission")
         .s3PrefixType("s3PrefixType")
         .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

    • CfnAccessGrantPropsMixin

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

    • CfnAccessGrantPropsMixin

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

    • CfnAccessGrantPropsMixin

      @Stability(Stable) public CfnAccessGrantPropsMixin(@NotNull CfnAccessGrantMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::S3::AccessGrant.

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

    • CfnAccessGrantPropsMixin

      @Stability(Stable) public CfnAccessGrantPropsMixin(@NotNull CfnAccessGrantMixinProps props)
      Create a mixin to apply properties to AWS::S3::AccessGrant.

      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 CfnAccessGrantMixinProps getProps()

    • getStrategy

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