Package software.amazon.awscdk.services.opensearchserverless

Interface CfnLifecyclePolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLifecyclePolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:25.857Z")
@Stability(Stable)
public interface CfnLifecyclePolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnLifecyclePolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 CfnLifecyclePolicyProps cfnLifecyclePolicyProps = CfnLifecyclePolicyProps.builder()
         .name("name")
         .policy("policy")
         .type("type")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLifecyclePolicyProps.Builder	A builder for CfnLifecyclePolicyProps
static final class	CfnLifecyclePolicyProps.Jsii$Proxy	An implementation for CfnLifecyclePolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnLifecyclePolicyProps.Builder	builder()
default String	getDescription()	The description of the lifecycle policy.
String	getName()	The name of the lifecycle policy.
String	getPolicy()	The JSON policy document without any whitespaces.
String	getType()	The type of lifecycle policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the lifecycle policy.

See Also:

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

getPolicy

@Stability(Stable)
@NotNull
String getPolicy()

The JSON policy document without any whitespaces.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of lifecycle policy.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the lifecycle policy.

See Also:

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

builder

@Stability(Stable)
static CfnLifecyclePolicyProps.Builder builder()

Returns:

a CfnLifecyclePolicyProps.Builder of CfnLifecyclePolicyProps