ServerlessLifecyclePolicy class

Resource for managing an AWS OpenSearch Serverless Lifecycle Policy. See AWS documentation for lifecycle policies.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.opensearch.ServerlessLifecyclePolicy("example", {
    name: "example",
    type: "retention",
    policy: JSON.stringify({
        Rules: [
            {
                ResourceType: "index",
                Resource: ["index/autoparts-inventory/*"],
                MinIndexRetention: "81d",
            },
            {
                ResourceType: "index",
                Resource: ["index/sales/orders*"],
                NoMinIndexRetention: true,
            },
        ],
    }),
});
import pulumi
import json
import pulumi_aws as aws

example = aws.opensearch.ServerlessLifecyclePolicy("example",
    name="example",
    type="retention",
    policy=json.dumps({
        "Rules": [
            {
                "ResourceType": "index",
                "Resource": ["index/autoparts-inventory/*"],
                "MinIndexRetention": "81d",
            },
            {
                "ResourceType": "index",
                "Resource": ["index/sales/orders*"],
                "NoMinIndexRetention": True,
            },
        ],
    }))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.OpenSearch.ServerlessLifecyclePolicy("example", new()
    {
        Name = "example",
        Type = "retention",
        Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Rules"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["ResourceType"] = "index",
                    ["Resource"] = new[]
                    {
                        "index/autoparts-inventory/*",
                    },
                    ["MinIndexRetention"] = "81d",
                },
                new Dictionary<string, object?>
                {
                    ["ResourceType"] = "index",
                    ["Resource"] = new[]
                    {
                        "index/sales/orders*",
                    },
                    ["NoMinIndexRetention"] = true,
                },
            },
        }),
    });

});
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string][]interface{}{
			"Rules": []interface{}{
				map[string]interface{}{
					"ResourceType": "index",
					"Resource": []string{
						"index/autoparts-inventory/*",
					},
					"MinIndexRetention": "81d",
				},
				map[string]interface{}{
					"ResourceType": "index",
					"Resource": []string{
						"index/sales/orders*",
					},
					"NoMinIndexRetention": true,
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = opensearch.NewServerlessLifecyclePolicy(ctx, "example", &opensearch.ServerlessLifecyclePolicyArgs{
			Name:   pulumi.String("example"),
			Type:   pulumi.String("retention"),
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_opensearch_serverlesslifecyclepolicy" "example" {
  name = "example"
  type = "retention"
  policy = jsonencode({
    "Rules" = [{
      "ResourceType"      = "index"
      "Resource"          = ["index/autoparts-inventory/*"]
      "MinIndexRetention" = "81d"
      }, {
      "ResourceType"        = "index"
      "Resource"            = ["index/sales/orders*"]
      "NoMinIndexRetention" = true
    }]
  })
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.ServerlessLifecyclePolicy;
import com.pulumi.aws.opensearch.ServerlessLifecyclePolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ServerlessLifecyclePolicy("example", ServerlessLifecyclePolicyArgs.builder()
            .name("example")
            .type("retention")
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Rules", jsonArray(
                        jsonObject(
                            jsonProperty("ResourceType", "index"),
                            jsonProperty("Resource", jsonArray("index/autoparts-inventory/*")),
                            jsonProperty("MinIndexRetention", "81d")
                        ),
                        jsonObject(
                            jsonProperty("ResourceType", "index"),
                            jsonProperty("Resource", jsonArray("index/sales/orders*")),
                            jsonProperty("NoMinIndexRetention", true)
                        )
                    ))
                )))
            .build());

    }
}
resources:
  example:
    type: aws:opensearch:ServerlessLifecyclePolicy
    properties:
      name: example
      type: retention
      policy:
        fn::toJSON:
          Rules:
            - ResourceType: index
              Resource:
                - index/autoparts-inventory/*
              MinIndexRetention: 81d
            - ResourceType: index
              Resource:
                - index/sales/orders*
              NoMinIndexRetention: true

Import

Identity Schema

Required

  • name (String) Name of the policy.
  • type (String) Type of lifecycle policy.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import OpenSearch Serverless Lifecycle Policy using the name and type arguments separated by a slash (/). For example:

$ pulumi import aws:opensearch/serverlessLifecyclePolicy:ServerlessLifecyclePolicy example example/retention

Constructors

ServerlessLifecyclePolicy(String name, {ServerlessLifecyclePolicyArgs? args, CustomResourceOptions? options})
Creates a new ServerlessLifecyclePolicy. name The Pulumi resource name. args Arguments used to configure this ServerlessLifecyclePolicy. The set of arguments for ServerlessLifecyclePolicy. options Resource options controlling this resource's behavior.
ServerlessLifecyclePolicy.reference(String urn)
Creates a typed reference to an existing ServerlessLifecyclePolicy resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description of the policy.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the policy.
latefinal
policy ↔ Output<String>
JSON policy document to use as the content for the new policy.
latefinal
policyVersion ↔ Output<String>
Version of the policy.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
Type of lifecycle policy. Must be retention.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ServerlessLifecyclePolicyState? state, CustomResourceOptions? options}) → ServerlessLifecyclePolicy
Gets an existing ServerlessLifecyclePolicy resource's state with the given name and id.