CfnAccessPolicyProps

class aws_cdk.aws_opensearchserverless.CfnAccessPolicyProps(*, name, policy, type, description=None)

Bases: object

Properties for defining a CfnAccessPolicy.

Parameters:

name (str) – The name of the policy.
policy (str) – The JSON policy document without any whitespaces.
type (str) – The type of access policy. Currently the only option is data .
description (Optional[str]) – The description of the policy.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_opensearchserverless as opensearchserverless

cfn_access_policy_props = opensearchserverless.CfnAccessPolicyProps(
    name="name",
    policy="policy",
    type="type",

    # the properties below are optional
    description="description"
)

Attributes

description

The description of the policy.

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

name

The name of the policy.

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

policy

The JSON policy document without any whitespaces.

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

type

The type of access policy.

Currently the only option is data .

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