aws-cdk-lib.aws_opensearchserverless.CfnAccessPolicyProps

interface CfnAccessPolicyProps

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchServerless.CfnAccessPolicyProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnAccessPolicyProps
Javasoftware.amazon.awscdk.services.opensearchserverless.CfnAccessPolicyProps
Pythonaws_cdk.aws_opensearchserverless.CfnAccessPolicyProps
TypeScript aws-cdk-lib » aws_opensearchserverless » CfnAccessPolicyProps

Properties for defining a CfnAccessPolicy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const cfnAccessPolicyProps: opensearchserverless.CfnAccessPolicyProps = {
  name: 'name',
  policy: 'policy',
  type: 'type',

  // the properties below are optional
  description: 'description',
};

Properties

NameTypeDescription
namestringThe name of the policy.
policystringThe JSON policy document without any whitespaces.
typestringThe type of access policy.
description?stringThe description of the policy.

name

Type: string

The name of the policy.


policy

Type: string

The JSON policy document without any whitespaces.


type

Type: string

The type of access policy.

Currently the only option is data .


description?

Type: string (optional)

The description of the policy.