Package software.amazon.awscdk.services.s3

Class CfnMultiRegionAccessPointPolicy

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.CfnMultiRegionAccessPointPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMultiRegionAccessPointPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:17.139Z") @Stability(Stable) public class CfnMultiRegionAccessPointPolicy extends CfnResource implements IInspectable, IMultiRegionAccessPointPolicyRef
Applies an Amazon S3 access policy to an Amazon S3 Multi-Region Access Point.

It is not possible to delete an access policy for a Multi-Region Access Point from the CloudFormation template. When you attempt to delete the policy, CloudFormation updates the policy using DeletionPolicy:Retain and UpdateReplacePolicy:Retain . CloudFormation updates the policy to only allow access to the account that created the bucket.

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.*;
 Object policy;
 CfnMultiRegionAccessPointPolicy cfnMultiRegionAccessPointPolicy = CfnMultiRegionAccessPointPolicy.Builder.create(this, "MyCfnMultiRegionAccessPointPolicy")
         .mrapName("mrapName")
         .policy(policy)
         .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

    • CfnMultiRegionAccessPointPolicy

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

    • CfnMultiRegionAccessPointPolicy

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

    • CfnMultiRegionAccessPointPolicy

      @Stability(Stable) public CfnMultiRegionAccessPointPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMultiRegionAccessPointPolicyProps props)
      Create a new AWS::S3::MultiRegionAccessPointPolicy.

      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. This parameter is required.

  • Method Details

    • isCfnMultiRegionAccessPointPolicy

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

      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.

    • getAttrPolicyStatus

      @Stability(Stable) @NotNull public IResolvable getAttrPolicyStatus()
      The Policy Status associated with this Multi Region Access Point.

    • getAttrPolicyStatusIsPublic

      @Stability(Stable) @NotNull public String getAttrPolicyStatusIsPublic()
      Specifies whether the policy is public or not.

    • getCfnProperties

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

    • getMultiRegionAccessPointPolicyRef

      @Stability(Stable) @NotNull public MultiRegionAccessPointPolicyReference getMultiRegionAccessPointPolicyRef()
      A reference to a MultiRegionAccessPointPolicy resource.
      Specified by:
      getMultiRegionAccessPointPolicyRef in interface IMultiRegionAccessPointPolicyRef

    • getMrapName

      @Stability(Stable) @NotNull public String getMrapName()
      The name of the Multi-Region Access Point.

    • setMrapName

      @Stability(Stable) public void setMrapName(@NotNull String value)
      The name of the Multi-Region Access Point.

    • getPolicy

      @Stability(Stable) @NotNull public Object getPolicy()
      The access policy associated with the Multi-Region Access Point.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull Object value)
      The access policy associated with the Multi-Region Access Point.