AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::OpenSearchServerless::AccessPolicy

CfnAccessPolicy

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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) .

Import

import { CfnAccessPolicy } from 'aws-cdk-lib/aws-opensearchserverless';

Or use the module namespace:

import * as opensearchserverless from 'aws-cdk-lib/aws-opensearchserverless';
// opensearchserverless.CfnAccessPolicy

Properties

Configuration passed to the constructor as CfnAccessPolicyProps.

nameRequired
string

The name of the policy.

policyRequired
string

The JSON policy document without any whitespaces.

typeRequired
string

The type of access policy. Currently the only option is `data` .

descriptionOptional
string

The description of the policy.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::OpenSearchServerless::AccessPolicyView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-opensearchserverless
CFN TypeAWS::OpenSearchServerless::AccessPolicy
Properties4

Related Constructs

Explore This Service

External Links