1. Packages
  2. AWS Native
  3. API Docs
  4. opensearchserverless
  5. LifecyclePolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.opensearchserverless.LifecyclePolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    Amazon OpenSearchServerless lifecycle policy resource

    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.
    
    

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeLifecyclePolicyResource = new aws_native.opensearchserverless.LifecyclePolicy("aws-nativeLifecyclePolicyResource", {
        policy: "string",
        type: aws_native.opensearchserverless.LifecyclePolicyType.Retention,
        description: "string",
        name: "string",
    });
    
    Coming soon!
    

    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

    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
    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
    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
    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
    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
    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"
    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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    LifecyclePolicyType, LifecyclePolicyTypeArgs

    Retention
    retention
    LifecyclePolicyTypeRetention
    retention
    Retention
    retention
    Retention
    retention
    RETENTION
    retention
    "retention"
    retention

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi