1. Packages
  2. AWS
  3. API Docs
  4. backup
  5. getPlan
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.backup.getPlan

aws logo
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

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

    Example Usage

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

const example = aws.backup.getPlan({
    planId: "my_example_backup_plan_id",
});

    import pulumi
import pulumi_aws as aws

example = aws.backup.get_plan(plan_id="my_example_backup_plan_id")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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: "my_example_backup_plan_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

    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("my_example_backup_plan_id")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:backup:getPlan
      arguments:
        planId: my_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,
             region: 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,
             region: 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)
public static Output<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:backup/getPlan:getPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PlanId string
    Backup plan ID.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Metadata that you can assign to help organize the plans you create.
    PlanId string
    Backup plan ID.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Metadata that you can assign to help organize the plans you create.
    planId String
    Backup plan ID.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Metadata that you can assign to help organize the plans you create.
    planId string
    Backup plan ID.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Metadata that you can assign to help organize the plans you create.
    plan_id str
    Backup plan ID.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Metadata that you can assign to help organize the plans you create.
    planId String
    Backup plan ID.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    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
    Region string
    Rules List<GetPlanRule>
    Rules of a backup plan.
    ScanSettings List<GetPlanScanSetting>
    Scanning configuration for the backup rule.
    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
    Region string
    Rules []GetPlanRule
    Rules of a backup plan.
    ScanSettings []GetPlanScanSetting
    Scanning configuration for the backup rule.
    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
    region String
    rules List<GetPlanRule>
    Rules of a backup plan.
    scanSettings List<GetPlanScanSetting>
    Scanning configuration for the backup rule.
    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
    region string
    rules GetPlanRule[]
    Rules of a backup plan.
    scanSettings GetPlanScanSetting[]
    Scanning configuration for the backup rule.
    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
    region str
    rules Sequence[GetPlanRule]
    Rules of a backup plan.
    scan_settings Sequence[GetPlanScanSetting]
    Scanning configuration for the backup rule.
    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
    region String
    rules List<Property Map>
    Rules of a backup plan.
    scanSettings List<Property Map>
    Scanning configuration for the backup rule.
    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.

    Supporting Types

    GetPlanRule

    GetPlanRuleCopyAction

    GetPlanRuleCopyActionLifecycle

    GetPlanRuleLifecycle

    GetPlanRuleScanAction

    GetPlanScanSetting

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.22.0
    published on Wednesday, Mar 11, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.