Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Retentionpolicy
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Retentionpolicy

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi: avi.Retentionpolicy” sidebar_current: “docs-avi-resource-retentionpolicy” description: |- Creates and manages Avi RetentionPolicy.

    avi.Retentionpolicy

    The RetentionPolicy resource allows the creation and management of Avi RetentionPolicy

    Example Usage

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

const foo = new avi.Retentionpolicy("foo", {tenantRef: "/api/tenant/?name=admin"});

    import pulumi
import pulumi_avi as avi

foo = avi.Retentionpolicy("foo", tenant_ref="/api/tenant/?name=admin")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewRetentionpolicy(ctx, "foo", &avi.RetentionpolicyArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Retentionpolicy("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Retentionpolicy;
import com.pulumi.avi.RetentionpolicyArgs;
import java.util.List;
import java.util.ArrayList;
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 foo = new Retentionpolicy("foo", RetentionpolicyArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}

    resources:
  foo:
    type: avi:Retentionpolicy
    properties:
      tenantRef: /api/tenant/?name=admin

    Create Retentionpolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Retentionpolicy(name: string, args: RetentionpolicyArgs, opts?: CustomResourceOptions);
    @overload
def Retentionpolicy(resource_name: str,
                    args: RetentionpolicyArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def Retentionpolicy(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    policies: Optional[Sequence[RetentionpolicyPolicyArgs]] = None,
                    enabled: Optional[str] = None,
                    histories: Optional[Sequence[RetentionpolicyHistoryArgs]] = None,
                    name: Optional[str] = None,
                    retentionpolicy_id: Optional[str] = None,
                    summaries: Optional[Sequence[RetentionpolicySummaryArgs]] = None,
                    tenant_ref: Optional[str] = None,
                    uuid: Optional[str] = None)
    func NewRetentionpolicy(ctx *Context, name string, args RetentionpolicyArgs, opts ...ResourceOption) (*Retentionpolicy, error)
    public Retentionpolicy(string name, RetentionpolicyArgs args, CustomResourceOptions? opts = null)
    public Retentionpolicy(String name, RetentionpolicyArgs args)
public Retentionpolicy(String name, RetentionpolicyArgs args, CustomResourceOptions options)

    type: avi:Retentionpolicy
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 RetentionpolicyArgs
    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 RetentionpolicyArgs
    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 RetentionpolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RetentionpolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RetentionpolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var retentionpolicyResource = new Avi.Retentionpolicy("retentionpolicyResource", new()
{
    Policies = new[]
    {
        new Avi.Inputs.RetentionpolicyPolicyArgs
        {
            Disks = new[]
            {
                new Avi.Inputs.RetentionpolicyPolicyDiskArgs
                {
                    Actions = new[]
                    {
                        new Avi.Inputs.RetentionpolicyPolicyDiskActionArgs
                        {
                            Args = new[]
                            {
                                new Avi.Inputs.RetentionpolicyPolicyDiskActionArgArgs
                                {
                                    Name = "string",
                                    Value = "string",
                                },
                            },
                            Path = "string",
                            Type = "string",
                        },
                    },
                    Filepath = "string",
                    MaxDiskPercent = "string",
                    MinFreeDiskPercent = "string",
                    Retain = "string",
                },
            },
            Objects = new[]
            {
                new Avi.Inputs.RetentionpolicyPolicyObjectArgs
                {
                    Actions = new[]
                    {
                        new Avi.Inputs.RetentionpolicyPolicyObjectActionArgs
                        {
                            Args = new[]
                            {
                                new Avi.Inputs.RetentionpolicyPolicyObjectActionArgArgs
                                {
                                    Name = "string",
                                    Value = "string",
                                },
                            },
                            Path = "string",
                            Type = "string",
                        },
                    },
                    Limit = "string",
                    ModelName = "string",
                },
            },
            Periodics = new[]
            {
                new Avi.Inputs.RetentionpolicyPolicyPeriodicArgs
                {
                    Actions = new[]
                    {
                        new Avi.Inputs.RetentionpolicyPolicyPeriodicActionArgs
                        {
                            Args = new[]
                            {
                                new Avi.Inputs.RetentionpolicyPolicyPeriodicActionArgArgs
                                {
                                    Name = "string",
                                    Value = "string",
                                },
                            },
                            Path = "string",
                            Type = "string",
                        },
                    },
                    Interval = "string",
                },
            },
        },
    },
    Enabled = "string",
    Histories = new[]
    {
        new Avi.Inputs.RetentionpolicyHistoryArgs
        {
            Duration = "string",
            EndTime = "string",
            Messages = new[]
            {
                "string",
            },
            StartTime = "string",
            Status = "string",
        },
    },
    Name = "string",
    RetentionpolicyId = "string",
    Summaries = new[]
    {
        new Avi.Inputs.RetentionpolicySummaryArgs
        {
            Duration = "string",
            EndTime = "string",
            Messages = new[]
            {
                "string",
            },
            StartTime = "string",
            Status = "string",
        },
    },
    TenantRef = "string",
    Uuid = "string",
});

    example, err := avi.NewRetentionpolicy(ctx, "retentionpolicyResource", &avi.RetentionpolicyArgs{
	Policies: avi.RetentionpolicyPolicyArray{
		&avi.RetentionpolicyPolicyArgs{
			Disks: avi.RetentionpolicyPolicyDiskArray{
				&avi.RetentionpolicyPolicyDiskArgs{
					Actions: avi.RetentionpolicyPolicyDiskActionArray{
						&avi.RetentionpolicyPolicyDiskActionArgs{
							Args: avi.RetentionpolicyPolicyDiskActionArgArray{
								&avi.RetentionpolicyPolicyDiskActionArgArgs{
									Name:  pulumi.String("string"),
									Value: pulumi.String("string"),
								},
							},
							Path: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Filepath:           pulumi.String("string"),
					MaxDiskPercent:     pulumi.String("string"),
					MinFreeDiskPercent: pulumi.String("string"),
					Retain:             pulumi.String("string"),
				},
			},
			Objects: avi.RetentionpolicyPolicyObjectArray{
				&avi.RetentionpolicyPolicyObjectArgs{
					Actions: avi.RetentionpolicyPolicyObjectActionArray{
						&avi.RetentionpolicyPolicyObjectActionArgs{
							Args: avi.RetentionpolicyPolicyObjectActionArgArray{
								&avi.RetentionpolicyPolicyObjectActionArgArgs{
									Name:  pulumi.String("string"),
									Value: pulumi.String("string"),
								},
							},
							Path: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Limit:     pulumi.String("string"),
					ModelName: pulumi.String("string"),
				},
			},
			Periodics: avi.RetentionpolicyPolicyPeriodicArray{
				&avi.RetentionpolicyPolicyPeriodicArgs{
					Actions: avi.RetentionpolicyPolicyPeriodicActionArray{
						&avi.RetentionpolicyPolicyPeriodicActionArgs{
							Args: avi.RetentionpolicyPolicyPeriodicActionArgArray{
								&avi.RetentionpolicyPolicyPeriodicActionArgArgs{
									Name:  pulumi.String("string"),
									Value: pulumi.String("string"),
								},
							},
							Path: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Interval: pulumi.String("string"),
				},
			},
		},
	},
	Enabled: pulumi.String("string"),
	Histories: avi.RetentionpolicyHistoryArray{
		&avi.RetentionpolicyHistoryArgs{
			Duration: pulumi.String("string"),
			EndTime:  pulumi.String("string"),
			Messages: pulumi.StringArray{
				pulumi.String("string"),
			},
			StartTime: pulumi.String("string"),
			Status:    pulumi.String("string"),
		},
	},
	Name:              pulumi.String("string"),
	RetentionpolicyId: pulumi.String("string"),
	Summaries: avi.RetentionpolicySummaryArray{
		&avi.RetentionpolicySummaryArgs{
			Duration: pulumi.String("string"),
			EndTime:  pulumi.String("string"),
			Messages: pulumi.StringArray{
				pulumi.String("string"),
			},
			StartTime: pulumi.String("string"),
			Status:    pulumi.String("string"),
		},
	},
	TenantRef: pulumi.String("string"),
	Uuid:      pulumi.String("string"),
})

    var retentionpolicyResource = new Retentionpolicy("retentionpolicyResource", RetentionpolicyArgs.builder()
    .policies(RetentionpolicyPolicyArgs.builder()
        .disks(RetentionpolicyPolicyDiskArgs.builder()
            .actions(RetentionpolicyPolicyDiskActionArgs.builder()
                .args(RetentionpolicyPolicyDiskActionArgArgs.builder()
                    .name("string")
                    .value("string")
                    .build())
                .path("string")
                .type("string")
                .build())
            .filepath("string")
            .maxDiskPercent("string")
            .minFreeDiskPercent("string")
            .retain("string")
            .build())
        .objects(RetentionpolicyPolicyObjectArgs.builder()
            .actions(RetentionpolicyPolicyObjectActionArgs.builder()
                .args(RetentionpolicyPolicyObjectActionArgArgs.builder()
                    .name("string")
                    .value("string")
                    .build())
                .path("string")
                .type("string")
                .build())
            .limit("string")
            .modelName("string")
            .build())
        .periodics(RetentionpolicyPolicyPeriodicArgs.builder()
            .actions(RetentionpolicyPolicyPeriodicActionArgs.builder()
                .args(RetentionpolicyPolicyPeriodicActionArgArgs.builder()
                    .name("string")
                    .value("string")
                    .build())
                .path("string")
                .type("string")
                .build())
            .interval("string")
            .build())
        .build())
    .enabled("string")
    .histories(RetentionpolicyHistoryArgs.builder()
        .duration("string")
        .endTime("string")
        .messages("string")
        .startTime("string")
        .status("string")
        .build())
    .name("string")
    .retentionpolicyId("string")
    .summaries(RetentionpolicySummaryArgs.builder()
        .duration("string")
        .endTime("string")
        .messages("string")
        .startTime("string")
        .status("string")
        .build())
    .tenantRef("string")
    .uuid("string")
    .build());

    retentionpolicy_resource = avi.Retentionpolicy("retentionpolicyResource",
    policies=[{
        "disks": [{
            "actions": [{
                "args": [{
                    "name": "string",
                    "value": "string",
                }],
                "path": "string",
                "type": "string",
            }],
            "filepath": "string",
            "max_disk_percent": "string",
            "min_free_disk_percent": "string",
            "retain": "string",
        }],
        "objects": [{
            "actions": [{
                "args": [{
                    "name": "string",
                    "value": "string",
                }],
                "path": "string",
                "type": "string",
            }],
            "limit": "string",
            "model_name": "string",
        }],
        "periodics": [{
            "actions": [{
                "args": [{
                    "name": "string",
                    "value": "string",
                }],
                "path": "string",
                "type": "string",
            }],
            "interval": "string",
        }],
    }],
    enabled="string",
    histories=[{
        "duration": "string",
        "end_time": "string",
        "messages": ["string"],
        "start_time": "string",
        "status": "string",
    }],
    name="string",
    retentionpolicy_id="string",
    summaries=[{
        "duration": "string",
        "end_time": "string",
        "messages": ["string"],
        "start_time": "string",
        "status": "string",
    }],
    tenant_ref="string",
    uuid="string")

    const retentionpolicyResource = new avi.Retentionpolicy("retentionpolicyResource", {
    policies: [{
        disks: [{
            actions: [{
                args: [{
                    name: "string",
                    value: "string",
                }],
                path: "string",
                type: "string",
            }],
            filepath: "string",
            maxDiskPercent: "string",
            minFreeDiskPercent: "string",
            retain: "string",
        }],
        objects: [{
            actions: [{
                args: [{
                    name: "string",
                    value: "string",
                }],
                path: "string",
                type: "string",
            }],
            limit: "string",
            modelName: "string",
        }],
        periodics: [{
            actions: [{
                args: [{
                    name: "string",
                    value: "string",
                }],
                path: "string",
                type: "string",
            }],
            interval: "string",
        }],
    }],
    enabled: "string",
    histories: [{
        duration: "string",
        endTime: "string",
        messages: ["string"],
        startTime: "string",
        status: "string",
    }],
    name: "string",
    retentionpolicyId: "string",
    summaries: [{
        duration: "string",
        endTime: "string",
        messages: ["string"],
        startTime: "string",
        status: "string",
    }],
    tenantRef: "string",
    uuid: "string",
});

    type: avi:Retentionpolicy
properties:
    enabled: string
    histories:
        - duration: string
          endTime: string
          messages:
            - string
          startTime: string
          status: string
    name: string
    policies:
        - disks:
            - actions:
                - args:
                    - name: string
                      value: string
                  path: string
                  type: string
              filepath: string
              maxDiskPercent: string
              minFreeDiskPercent: string
              retain: string
          objects:
            - actions:
                - args:
                    - name: string
                      value: string
                  path: string
                  type: string
              limit: string
              modelName: string
          periodics:
            - actions:
                - args:
                    - name: string
                      value: string
                  path: string
                  type: string
              interval: string
    retentionpolicyId: string
    summaries:
        - duration: string
          endTime: string
          messages:
            - string
          startTime: string
          status: string
    tenantRef: string
    uuid: string

    Retentionpolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Retentionpolicy resource accepts the following input properties:

    Policies List<RetentionpolicyPolicy>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Histories List<RetentionpolicyHistory>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RetentionpolicyId string
    Summaries List<RetentionpolicySummary>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Policies []RetentionpolicyPolicyArgs
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Histories []RetentionpolicyHistoryArgs
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RetentionpolicyId string
    Summaries []RetentionpolicySummaryArgs
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies List<RetentionpolicyPolicy>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled String
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories List<RetentionpolicyHistory>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId String
    summaries List<RetentionpolicySummary>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies RetentionpolicyPolicy[]
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories RetentionpolicyHistory[]
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId string
    summaries RetentionpolicySummary[]
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies Sequence[RetentionpolicyPolicyArgs]
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled str
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories Sequence[RetentionpolicyHistoryArgs]
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicy_id str
    summaries Sequence[RetentionpolicySummaryArgs]
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies List<Property Map>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled String
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories List<Property Map>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId String
    summaries List<Property Map>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Retentionpolicy 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.

    Look up Existing Retentionpolicy Resource

    Get an existing Retentionpolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RetentionpolicyState, opts?: CustomResourceOptions): Retentionpolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[str] = None,
        histories: Optional[Sequence[RetentionpolicyHistoryArgs]] = None,
        name: Optional[str] = None,
        policies: Optional[Sequence[RetentionpolicyPolicyArgs]] = None,
        retentionpolicy_id: Optional[str] = None,
        summaries: Optional[Sequence[RetentionpolicySummaryArgs]] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None) -> Retentionpolicy
    func GetRetentionpolicy(ctx *Context, name string, id IDInput, state *RetentionpolicyState, opts ...ResourceOption) (*Retentionpolicy, error)
    public static Retentionpolicy Get(string name, Input<string> id, RetentionpolicyState? state, CustomResourceOptions? opts = null)
    public static Retentionpolicy get(String name, Output<String> id, RetentionpolicyState state, CustomResourceOptions options)
    resources:  _:    type: avi:Retentionpolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Histories List<RetentionpolicyHistory>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Policies List<RetentionpolicyPolicy>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RetentionpolicyId string
    Summaries List<RetentionpolicySummary>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Histories []RetentionpolicyHistoryArgs
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Policies []RetentionpolicyPolicyArgs
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    RetentionpolicyId string
    Summaries []RetentionpolicySummaryArgs
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled String
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories List<RetentionpolicyHistory>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies List<RetentionpolicyPolicy>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId String
    summaries List<RetentionpolicySummary>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled string
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories RetentionpolicyHistory[]
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies RetentionpolicyPolicy[]
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId string
    summaries RetentionpolicySummary[]
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled str
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories Sequence[RetentionpolicyHistoryArgs]
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies Sequence[RetentionpolicyPolicyArgs]
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicy_id str
    summaries Sequence[RetentionpolicySummaryArgs]
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    enabled String
    Enables the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    histories List<Property Map>
    History of previous runs. Field introduced in 31.1.1. Maximum of 10 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    policies List<Property Map>
    Policy specification. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    retentionpolicyId String
    summaries List<Property Map>
    Details of most recent run. Field introduced in 31.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    Tenant uuid associated with the object. It is a reference to an object of type tenant. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid identifier for the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.

    Supporting Types

    RetentionpolicyHistory, RetentionpolicyHistoryArgs

    Duration string
    EndTime string
    Messages List<string>
    StartTime string
    Status string
    Duration string
    EndTime string
    Messages []string
    StartTime string
    Status string
    duration String
    endTime String
    messages List<String>
    startTime String
    status String
    duration string
    endTime string
    messages string[]
    startTime string
    status string
    duration str
    end_time str
    messages Sequence[str]
    start_time str
    status str
    duration String
    endTime String
    messages List<String>
    startTime String
    status String

    RetentionpolicyPolicy, RetentionpolicyPolicyArgs

    RetentionpolicyPolicyDisk, RetentionpolicyPolicyDiskArgs

    RetentionpolicyPolicyDiskAction, RetentionpolicyPolicyDiskActionArgs

    RetentionpolicyPolicyDiskActionArg, RetentionpolicyPolicyDiskActionArgArgs

    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String
    name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value string
    name str
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value str
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String

    RetentionpolicyPolicyObject, RetentionpolicyPolicyObjectArgs

    RetentionpolicyPolicyObjectAction, RetentionpolicyPolicyObjectActionArgs

    RetentionpolicyPolicyObjectActionArg, RetentionpolicyPolicyObjectActionArgArgs

    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String
    name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value string
    name str
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value str
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String

    RetentionpolicyPolicyPeriodic, RetentionpolicyPolicyPeriodicArgs

    RetentionpolicyPolicyPeriodicAction, RetentionpolicyPolicyPeriodicActionArgs

    RetentionpolicyPolicyPeriodicActionArg, RetentionpolicyPolicyPeriodicActionArgArgs

    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    Name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    Value string
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String
    name string
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value string
    name str
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value str
    name String
    Name of the policy. Field introduced in 31.1.1. Allowed with any value in enterprise, enterprise with cloud services edition.
    value String

    RetentionpolicySummary, RetentionpolicySummaryArgs

    Duration string
    EndTime string
    Messages List<string>
    StartTime string
    Status string
    Duration string
    EndTime string
    Messages []string
    StartTime string
    Status string
    duration String
    endTime String
    messages List<String>
    startTime String
    status String
    duration string
    endTime string
    messages string[]
    startTime string
    status string
    duration str
    end_time str
    messages Sequence[str]
    start_time str
    status str
    duration String
    endTime String
    messages List<String>
    startTime String
    status String

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-avi