lifecycle_policies

Creates, updates, deletes, gets or lists a lifecycle_policies resource.

Overview

Name	lifecycle_policies
Type	Resource
Id	aws.opensearchserverless.lifecycle_policies

Fields

The following fields are returned by SELECT queries:

batch_get_lifecycle_policy

Name	Datatype	Description
lifecycle_policy_details	array	A list of lifecycle policies matched to the input policy name and policy type.
lifecycle_policy_error_details	array	A list of lifecycle policy names and policy types for which retrieval failed.

list_lifecycle_policies

Name	Datatype	Description
lifecycle_policy_summaries	array	Details about the requested lifecycle policies.
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_lifecycle_policy	select	region		Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
list_lifecycle_policies	select	region		Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.
create_lifecycle_policy	insert	region, type, name, policy		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.
update_lifecycle_policy	update	region, type, name, policyVersion		Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.
delete_lifecycle_policy	delete	region		Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_lifecycle_policy

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

SELECT
lifecycle_policy_details,
lifecycle_policy_error_details
FROM aws.opensearchserverless.lifecycle_policies
WHERE region = '{{ region }}' -- required
;

list_lifecycle_policies

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

SELECT
lifecycle_policy_summaries,
next_token
FROM aws.opensearchserverless.lifecycle_policies
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_lifecycle_policy

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.

INSERT INTO aws.opensearchserverless.lifecycle_policies (
type,
name,
description,
policy,
clientToken,
region
)
SELECT 
'{{ type }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ policy }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
lifecycle_policy_detail
;

Manifest

# Description fields are for documentation purposes
- name: lifecycle_policies
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the lifecycle_policies resource.
  - name: type
    value: "{{ type }}"
    description: |
      The type of lifecycle policy.
    valid_values: ['retention']
  - name: name
    value: "{{ name }}"
    description: |
      The name of the lifecycle policy.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the lifecycle policy.
  - name: policy
    value: "{{ policy }}"
    description: |
      The JSON policy document to use as the content for the lifecycle policy.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A unique, case-sensitive identifier to ensure idempotency of the request.

UPDATE examples

update_lifecycle_policy

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

UPDATE aws.opensearchserverless.lifecycle_policies
SET 
type = '{{ type }}',
name = '{{ name }}',
policyVersion = '{{ policyVersion }}',
description = '{{ description }}',
policy = '{{ policy }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND type = '{{ type }}' --required
AND name = '{{ name }}' --required
AND policyVersion = '{{ policyVersion }}' --required
RETURNING
lifecycle_policy_detail;

DELETE examples

delete_lifecycle_policy

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

DELETE FROM aws.opensearchserverless.lifecycle_policies
WHERE region = '{{ region }}' --required
;