interface CfnAccessPolicyProps

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchServerless.CfnAccessPolicyProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnAccessPolicyProps
Java	software.amazon.awscdk.services.opensearchserverless.CfnAccessPolicyProps
Python	aws_cdk.aws_opensearchserverless.CfnAccessPolicyProps
TypeScript	aws-cdk-lib » aws_opensearchserverless » CfnAccessPolicyProps

Properties for defining a CfnAccessPolicy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html

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

Name	Type	Description
name	string	The name of the policy.
policy	string	The JSON policy document without any whitespaces.
type	string	The type of access policy.
description?	string	The description of the policy.

---

name

Type: string

The name of the policy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-name

---

policy

Type: string

The JSON policy document without any whitespaces.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-policy

---

type

Type: string

The type of access policy.

Currently the only option is data .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-type

---

description?

Type: string (optional)

The description of the policy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-description