Skip to content

EffectiveLifecyclePolicyDetail

Source code in docs_src/capo_opensearchserverless/types/effective_lifecycle_policy_detail.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class EffectiveLifecyclePolicyDetail(TypedDict, closed=True):
    type: NotRequired[
        "capo_opensearchserverless.types.lifecycle_policy_type.LifecyclePolicyType"
    ]
    """<p>The type of lifecycle policy.</p>"""
    resource: NotRequired["capo_opensearchserverless.types.resource.Resource"]
    """<p>The name of the OpenSearch Serverless index resource.</p>"""
    policy_name: NotRequired["capo_opensearchserverless.types.policy_name.PolicyName"]
    """<p>The name of the lifecycle policy.</p>"""
    resource_type: NotRequired[
        "capo_opensearchserverless.types.resource_type.ResourceType"
    ]
    """<p>The type of OpenSearch Serverless resource. Currently, the only supported resource is <code>index</code>.</p>"""
    retention_period: NotRequired["str"]
    """<p>The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.</p>"""
    no_min_retention_period: NotRequired["bool"]
    """<p>The minimum number of index retention days set. That is an optional param that will return as <code>true</code> if the minimum number of days or hours is not set to a index resource.</p>"""

no_min_retention_period instance-attribute 

no_min_retention_period: NotRequired[bool]

The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

policy_name instance-attribute 

policy_name: NotRequired[PolicyName]

The name of the lifecycle policy.

resource instance-attribute 

resource: NotRequired[Resource]

The name of the OpenSearch Serverless index resource.

resource_type instance-attribute 

resource_type: NotRequired[ResourceType]

The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

retention_period instance-attribute 

retention_period: NotRequired[str]

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

type instance-attribute 

type: NotRequired[LifecyclePolicyType]

The type of lifecycle policy.