1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. opensearchserverless
  6. LifecyclePolicy

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::OpenSearchServerless::LifecyclePolicy

    Create LifecyclePolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LifecyclePolicy(name: string, args: LifecyclePolicyArgs, opts?: CustomResourceOptions);
    @overload
    def LifecyclePolicy(resource_name: str,
                        args: LifecyclePolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def LifecyclePolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        policy: Optional[str] = None,
                        type: Optional[LifecyclePolicyType] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None)
    func NewLifecyclePolicy(ctx *Context, name string, args LifecyclePolicyArgs, opts ...ResourceOption) (*LifecyclePolicy, error)
    public LifecyclePolicy(string name, LifecyclePolicyArgs args, CustomResourceOptions? opts = null)
    public LifecyclePolicy(String name, LifecyclePolicyArgs args)
    public LifecyclePolicy(String name, LifecyclePolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:opensearchserverless:LifecyclePolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_opensearchserverless_lifecycle_policy" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LifecyclePolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LifecyclePolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LifecyclePolicy resource accepts the following input properties:

    Policy string
    The JSON policy document that is the content for the policy
    Type Pulumi.AwsNative.OpenSearchServerless.LifecyclePolicyType
    The type of lifecycle policy.
    Description string
    The description of the policy
    Name string
    The name of the policy
    Policy string
    The JSON policy document that is the content for the policy
    Type LifecyclePolicyType
    The type of lifecycle policy.
    Description string
    The description of the policy
    Name string
    The name of the policy
    policy string
    The JSON policy document that is the content for the policy
    type "retention"
    The type of lifecycle policy.
    description string
    The description of the policy
    name string
    The name of the policy
    policy String
    The JSON policy document that is the content for the policy
    type LifecyclePolicyType
    The type of lifecycle policy.
    description String
    The description of the policy
    name String
    The name of the policy
    policy string
    The JSON policy document that is the content for the policy
    type LifecyclePolicyType
    The type of lifecycle policy.
    description string
    The description of the policy
    name string
    The name of the policy
    policy str
    The JSON policy document that is the content for the policy
    type LifecyclePolicyType
    The type of lifecycle policy.
    description str
    The description of the policy
    name str
    The name of the policy
    policy String
    The JSON policy document that is the content for the policy
    type "retention"
    The type of lifecycle policy.
    description String
    The description of the policy
    name String
    The name of the policy

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LifecyclePolicy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LifecyclePolicy Resource

    Get an existing LifecyclePolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): LifecyclePolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> LifecyclePolicy
    func GetLifecyclePolicy(ctx *Context, name string, id IDInput, state *LifecyclePolicyState, opts ...ResourceOption) (*LifecyclePolicy, error)
    public static LifecyclePolicy Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static LifecyclePolicy get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingLifecyclePolicy:    type: aws-native:opensearchserverless:LifecyclePolicy    get:      id: ${id}
    import {
      to = aws-native_opensearchserverless_lifecycle_policy.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state LifecyclePolicyState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    LifecyclePolicyType

    The type of lifecycle policy

    NameValue
    Retentionretention
    NameValue
    LifecyclePolicyTypeRetentionretention
    Value
    retention
    NameValue
    Retentionretention
    NameValue
    Retentionretention
    NameValue
    RETENTIONretention
    Value
    retention

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial