lifecycle_policies

Creates, updates, deletes or gets a lifecycle_policy resource or lists lifecycle_policies in a region

Overview

Name	lifecycle_policies
Type	Resource
Description	Amazon OpenSearchServerless lifecycle policy resource
Id	awscc.opensearchserverless.lifecycle_policies

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the policy
type	string	The type of lifecycle policy
description	string	The description of the policy
policy	string	The JSON policy document that is the content for the policy
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the policy
type	string	The type of lifecycle policy
region	string	AWS region.

For more information, see AWS::OpenSearchServerless::LifecyclePolicy.

Methods

Name	Resource	Accessible by	Required Params
create_resource	lifecycle_policies	INSERT	Type, Name, Policy, region
delete_resource	lifecycle_policies	DELETE	Identifier, region
update_resource	lifecycle_policies	UPDATE	Identifier, PatchDocument, region
list_resources	lifecycle_policies_list_only	SELECT	region
get_resource	lifecycle_policies	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual lifecycle_policy.

SELECT
  region,
  name,
  type,
  description,
  policy
FROM awscc.opensearchserverless.lifecycle_policies
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ type }}|{{ name }}';

list (identifiers only)

Lists all lifecycle_policies in a region.

SELECT
  region,
  type,
  name
FROM awscc.opensearchserverless.lifecycle_policies_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new lifecycle_policy resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.lifecycle_policies (
  Name,
  Type,
  Policy,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ policy }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.lifecycle_policies (
  Name,
  Type,
  Description,
  Policy,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ description }}',
  '{{ policy }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: lifecycle_policy
    props:
      - name: name
        value: '{{ name }}'
      - name: type
        value: '{{ type }}'
      - name: description
        value: '{{ description }}'
      - name: policy
        value: '{{ policy }}'

UPDATE example

Use the following StackQL query and manifest file to update a lifecycle_policy resource, using stack-deploy.

/*+ update */
UPDATE awscc.opensearchserverless.lifecycle_policies
SET PatchDocument = string('{{ {
    "Description": description,
    "Policy": policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ type }}|{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.opensearchserverless.lifecycle_policies
WHERE
  Identifier = '{{ type }}|{{ name }}' AND
  region = 'us-east-1';

Permissions

To operate on the lifecycle_policies resource, the following permissions are required:

Create

aoss:CreateLifecyclePolicy

Read

aoss:BatchGetLifecyclePolicy

Update

aoss:UpdateLifecyclePolicy,
aoss:BatchGetLifecyclePolicy

Delete

aoss:DeleteLifecyclePolicy

List

aoss:ListLifecyclePolicies