Package software.amazon.awscdk.services.opensearchserverless

Class CfnAccessPolicy

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.opensearchserverless.CfnAccessPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAccessPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:25.223Z") @Stability(Stable) public class CfnAccessPolicy extends CfnResource implements IInspectable, IAccessPolicyRef
Creates a data access policy for OpenSearch Serverless.

Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless .

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.opensearchserverless.*;
 CfnAccessPolicy cfnAccessPolicy = CfnAccessPolicy.Builder.create(this, "MyCfnAccessPolicy")
         .name("name")
         .policy("policy")
         .type("type")
         // the properties below are optional
         .description("description")
         .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

    • CfnAccessPolicy

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

    • CfnAccessPolicy

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

    • CfnAccessPolicy

      @Stability(Stable) public CfnAccessPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAccessPolicyProps props)
      Create a new AWS::OpenSearchServerless::AccessPolicy.

      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

    • isCfnAccessPolicy

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

      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.

    • getAccessPolicyRef

      @Stability(Stable) @NotNull public AccessPolicyReference getAccessPolicyRef()
      A reference to a AccessPolicy resource.
      Specified by:
      getAccessPolicyRef in interface IAccessPolicyRef

    • getCfnProperties

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the policy.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the policy.

    • getPolicy

      @Stability(Stable) @NotNull public String getPolicy()
      The JSON policy document without any whitespaces.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull String value)
      The JSON policy document without any whitespaces.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of access policy.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of access policy.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the policy.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the policy.