Class CfnLifecyclePolicy

All Implemented Interfaces:
IInspectable,, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.071Z") @Stability(Stable) public class CfnLifecyclePolicy extends CfnResource implements IInspectable
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnLifecyclePolicy cfnLifecyclePolicy = CfnLifecyclePolicy.Builder.create(this, "MyCfnLifecyclePolicy")
         // the properties below are optional

See Also:
  • Field Details


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

    • CfnLifecyclePolicy

      protected CfnLifecyclePolicy( objRef)
    • CfnLifecyclePolicy

      protected CfnLifecyclePolicy( initializationMode)
    • CfnLifecyclePolicy

      @Stability(Stable) public CfnLifecyclePolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLifecyclePolicyProps props)
      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

    • inspect

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

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • 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.