1. Docs
  2. Reference
  3. API
  4. AWS
  5. backup
  6. GetPlan

GetPlan

Use this data source to get information on an existing backup plan.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.Backup.GetPlan.InvokeAsync(new Aws.Backup.GetPlanArgs
        {
            PlanId = "tf_example_backup_plan_id",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/backup"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := backup.LookupPlan(ctx, &backup.LookupPlanArgs{
            PlanId: "tf_example_backup_plan_id",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

example = aws.backup.get_plan(plan_id="tf_example_backup_plan_id")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.backup.getPlan({
    planId: "tf_example_backup_plan_id",
}, { async: true }));

Using GetPlan

function getPlan(args: GetPlanArgs, opts?: InvokeOptions): Promise<GetPlanResult>
function  get_plan(plan_id=None, tags=None, opts=None)
func LookupPlan(ctx *Context, args *LookupPlanArgs, opts ...InvokeOption) (*LookupPlanResult, error)

Note: This function is named LookupPlan in the Go SDK.

public static class GetPlan {
    public static Task<GetPlanResult> InvokeAsync(GetPlanArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

PlanId string

The backup plan ID.

Tags Dictionary<string, string>

Metadata that you can assign to help organize the plans you create.

PlanId string

The backup plan ID.

Tags map[string]string

Metadata that you can assign to help organize the plans you create.

planId string

The backup plan ID.

tags {[key: string]: string}

Metadata that you can assign to help organize the plans you create.

plan_id str

The backup plan ID.

tags Dict[str, str]

Metadata that you can assign to help organize the plans you create.

GetPlan Result

The following output properties are available:

Arn string

The ARN of the backup plan.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The display name of a backup plan.

PlanId string
Tags Dictionary<string, string>

Metadata that you can assign to help organize the plans you create.

Version string

Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

Arn string

The ARN of the backup plan.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The display name of a backup plan.

PlanId string
Tags map[string]string

Metadata that you can assign to help organize the plans you create.

Version string

Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

arn string

The ARN of the backup plan.

id string

The provider-assigned unique ID for this managed resource.

name string

The display name of a backup plan.

planId string
tags {[key: string]: string}

Metadata that you can assign to help organize the plans you create.

version string

Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

arn str

The ARN of the backup plan.

id str

The provider-assigned unique ID for this managed resource.

name str

The display name of a backup plan.

plan_id str
tags Dict[str, str]

Metadata that you can assign to help organize the plans you create.

version str

Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.