Package software.amazon.awscdk.services.s3

Class CfnAccessGrantsInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3.CfnAccessGrantsInstance
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAccessGrantsInstanceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:21.583Z") @Stability(Stable) public class CfnAccessGrantsInstance extends CfnResource implements IInspectable, IAccessGrantsInstanceRef, ITaggableV2
The AWS::S3::AccessGrantInstance resource creates an S3 Access Grants instance, which serves as a logical grouping for access grants.

You can create one S3 Access Grants instance per Region per account.

  • Permissions - You must have the s3:CreateAccessGrantsInstance permission to use this resource.
  • Additional Permissions - To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the sso:DescribeInstance , sso:CreateApplication , sso:PutApplicationGrant , and sso:PutApplicationAuthenticationMethod permissions.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 CfnAccessGrantsInstance cfnAccessGrantsInstance = CfnAccessGrantsInstance.Builder.create(this, "MyCfnAccessGrantsInstance")
         .identityCenterArn("identityCenterArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccessGrantsInstance

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

    • CfnAccessGrantsInstance

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

    • CfnAccessGrantsInstance

      @Stability(Stable) public CfnAccessGrantsInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnAccessGrantsInstanceProps props)
      Create a new AWS::S3::AccessGrantsInstance.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnAccessGrantsInstance

      @Stability(Stable) public CfnAccessGrantsInstance(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::S3::AccessGrantsInstance.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForAccessGrantsInstance

      @Stability(Stable) @NotNull public static String arnForAccessGrantsInstance(@NotNull IAccessGrantsInstanceRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAccessGrantsInstance

      @Stability(Stable) @NotNull public static Boolean isCfnAccessGrantsInstance(@NotNull Object x)
      Checks whether the given object is a CfnAccessGrantsInstance.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAccessGrantsInstanceRef

      @Stability(Stable) @NotNull public AccessGrantsInstanceReference getAccessGrantsInstanceRef()
      A reference to a AccessGrantsInstance resource.
      Specified by:
      getAccessGrantsInstanceRef in interface IAccessGrantsInstanceRef

    • getAttrAccessGrantsInstanceArn

      @Stability(Stable) @NotNull public String getAttrAccessGrantsInstanceArn()
      The ARN of the S3 Access Grants instance.

    • getAttrAccessGrantsInstanceId

      @Stability(Stable) @NotNull public String getAttrAccessGrantsInstanceId()
      The ID of the S3 Access Grants instance.

      The ID is default . You can have one S3 Access Grants instance per Region per account.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentityCenterArn

      @Stability(Stable) @Nullable public String getIdentityCenterArn()
      If you would like to associate your S3 Access Grants instance with an AWS IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance.

    • setIdentityCenterArn

      @Stability(Stable) public void setIdentityCenterArn(@Nullable String value)
      If you would like to associate your S3 Access Grants instance with an AWS IAM Identity Center instance, use this field to pass the Amazon Resource Name (ARN) of the AWS IAM Identity Center instance that you are associating with your S3 Access Grants instance.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The AWS resource tags that you are adding to the S3 Access Grants instance.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The AWS resource tags that you are adding to the S3 Access Grants instance.