Package com.pulumi.aws.opensearch

Class ServerlessLifecyclePolicy

  • public class ServerlessLifecyclePolicy
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS OpenSearch Serverless Lifecycle Policy. See AWS documentation for [lifecycle policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html). ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:opensearch/serverlessLifecyclePolicy:ServerlessLifecyclePolicy example example/retention ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static ServerlessLifecyclePolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ServerlessLifecyclePolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> policy()  
      com.pulumi.core.Output<java.lang.String> policyVersion()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ServerlessLifecyclePolicy

        public ServerlessLifecyclePolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ServerlessLifecyclePolicy

        public ServerlessLifecyclePolicy​(java.lang.String name,
                                 ServerlessLifecyclePolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ServerlessLifecyclePolicy

        public ServerlessLifecyclePolicy​(java.lang.String name,
                                 ServerlessLifecyclePolicyArgs args,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the policy.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the policy.

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        JSON policy document to use as the content for the new policy.

      • policyVersion

        public com.pulumi.core.Output<java.lang.String> policyVersion()
        Returns:
        Version of the policy.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of lifecycle policy. Must be `retention`. The following arguments are optional:

      • get

        public static ServerlessLifecyclePolicy get​(java.lang.String name,
                                            com.pulumi.core.Output<java.lang.String> id,
                                            @Nullable
                                            ServerlessLifecyclePolicyState state,
                                            @Nullable
                                            com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.