Package software.amazon.awscdk.services.opensearchserverless

Class CfnLifecyclePolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.opensearchserverless.CfnLifecyclePolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILifecyclePolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:25.246Z") @Stability(Stable) public class CfnLifecyclePolicy extends CfnResource implements IInspectable, ILifecyclePolicyRef
Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.

Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies .

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.*;
 CfnLifecyclePolicy cfnLifecyclePolicy = CfnLifecyclePolicy.Builder.create(this, "MyCfnLifecyclePolicy")
         .name("name")
         .policy("policy")
         .type("type")
         // the properties below are optional
         .description("description")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLifecyclePolicy

      protected CfnLifecyclePolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLifecyclePolicy

      protected CfnLifecyclePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLifecyclePolicy

      @Stability(Stable) public CfnLifecyclePolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLifecyclePolicyProps props)
      Create a new AWS::OpenSearchServerless::LifecyclePolicy.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnLifecyclePolicy

      @Stability(Stable) @NotNull public static Boolean isCfnLifecyclePolicy(@NotNull Object x)
      Checks whether the given object is a CfnLifecyclePolicy.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLifecyclePolicyRef

      @Stability(Stable) @NotNull public LifecyclePolicyReference getLifecyclePolicyRef()
      A reference to a LifecyclePolicy resource.
      Specified by:
      getLifecyclePolicyRef in interface ILifecyclePolicyRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the lifecycle policy.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the lifecycle policy.

    • getPolicy

      @Stability(Stable) @NotNull public String getPolicy()
      The JSON policy document without any whitespaces.

    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull String value)
      The JSON policy document without any whitespaces.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of lifecycle policy.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of lifecycle policy.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the lifecycle policy.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the lifecycle policy.