AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

getPlan

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Backup.GetPlan.Invoke(new()
    {
        PlanId = "tf_example_backup_plan_id",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/backup"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.BackupFunctions;
import com.pulumi.aws.backup.inputs.GetPlanArgs;
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) {
        final var example = BackupFunctions.getPlan(GetPlanArgs.builder()
            .planId("tf_example_backup_plan_id")
            .build());

    }
}
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",
}));
variables:
  example:
    Fn::Invoke:
      Function: aws:backup:getPlan
      Arguments:
        planId: tf_example_backup_plan_id

Using getPlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPlan(args: GetPlanArgs, opts?: InvokeOptions): Promise<GetPlanResult>
function getPlanOutput(args: GetPlanOutputArgs, opts?: InvokeOptions): Output<GetPlanResult>
def get_plan(plan_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             opts: Optional[InvokeOptions] = None) -> GetPlanResult
def get_plan_output(plan_id: Optional[pulumi.Input[str]] = None,
             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPlanResult]
func LookupPlan(ctx *Context, args *LookupPlanArgs, opts ...InvokeOption) (*LookupPlanResult, error)
func LookupPlanOutput(ctx *Context, args *LookupPlanOutputArgs, opts ...InvokeOption) LookupPlanResultOutput

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

public static class GetPlan 
{
    public static Task<GetPlanResult> InvokeAsync(GetPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetPlanResult> Invoke(GetPlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:backup/getPlan:getPlan
  Arguments:
    # Arguments dictionary

The following arguments are supported:

PlanId string

Backup plan ID.

Tags Dictionary<string, string>

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

PlanId string

Backup plan ID.

Tags map[string]string

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

planId String

Backup plan ID.

tags Map<String,String>

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

planId string

Backup plan ID.

tags {[key: string]: string}

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

plan_id str

Backup plan ID.

tags Mapping[str, str]

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

planId String

Backup plan ID.

tags Map<String>

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

getPlan Result

The following output properties are available:

Arn string

ARN of the backup plan.

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

ARN of the backup plan.

Id string

The provider-assigned unique ID for this managed resource.

Name string

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

ARN of the backup plan.

id String

The provider-assigned unique ID for this managed resource.

name String

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

ARN of the backup plan.

id string

The provider-assigned unique ID for this managed resource.

name string

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

ARN of the backup plan.

id str

The provider-assigned unique ID for this managed resource.

name str

Display name of a backup plan.

plan_id str
tags Mapping[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.

arn String

ARN of the backup plan.

id String

The provider-assigned unique ID for this managed resource.

name String

Display name of a backup plan.

planId String
tags Map<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.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.