CfnLifecyclePolicyProps

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

Bases: object

Properties for defining a CfnLifecyclePolicy.

Parameters:
  • name (str) – The name of the lifecycle policy.

  • policy (str) – The JSON policy document without any whitespaces.

  • type (str) – The type of lifecycle policy.

  • description (Optional[str]) – The description of the lifecycle policy.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_lifecycle_policy_props = opensearchserverless.CfnLifecyclePolicyProps(
    name="name",
    policy="policy",
    type="type",

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

Attributes

description

The description of the lifecycle policy.

See:

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

name

The name of the lifecycle policy.

See:

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

policy

The JSON policy document without any whitespaces.

See:

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

type

The type of lifecycle policy.

See:

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