Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
published on Friday, Oct 16, 2026 by Pulumi
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
published on Friday, Oct 16, 2026 by Pulumi
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.ArrayList;
import java.util.Arrays;
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
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_backup_getplan" "example" {
plan_id = "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?: InvokeOutputOptions): 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: pulumi.Input[Optional[str]] = None,
region: pulumi.Input[Optional[str]] = None,
tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOutputOptions] = 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 Output<GetPlanResult> Invoke(GetPlanInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)
public static Output<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)
public static Output<GetPlanResult> getPlan(GetPlanArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws:backup/getPlan:getPlan
arguments:
# arguments dictionarydata "aws_backup_get_plan" "name" {
# arguments
}The following arguments are supported:
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.
- Plan
Id string - Region string
- Rules
List<Get
Plan Rule> - Rules of a backup plan. See below.
- Scan
Settings List<GetPlan Scan Setting> - Scanning configuration for the backup rule. See below.
- 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.
- Plan
Id string - Region string
- Rules
[]Get
Plan Rule - Rules of a backup plan. See below.
- Scan
Settings []GetPlan Scan Setting - Scanning configuration for the backup rule. See below.
- 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.
- plan_
id string - region string
- rules list(object)
- Rules of a backup plan. See below.
- scan_
settings list(object) - Scanning configuration for the backup rule. See below.
- 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.
- 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.
- plan
Id String - region String
- rules
List<Get
Plan Rule> - Rules of a backup plan. See below.
- scan
Settings List<GetPlan Scan Setting> - Scanning configuration for the backup rule. See below.
- 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.
- plan
Id string - region string
- rules
Get
Plan Rule[] - Rules of a backup plan. See below.
- scan
Settings GetPlan Scan Setting[] - Scanning configuration for the backup rule. See below.
- {[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[Get
Plan Rule] - Rules of a backup plan. See below.
- scan_
settings Sequence[GetPlan Scan Setting] - Scanning configuration for the backup rule. See below.
- 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.
- plan
Id String - region String
- rules List<Property Map>
- Rules of a backup plan. See below.
- scan
Settings List<Property Map> - Scanning configuration for the backup rule. See below.
- 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
- Completion
Window int - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- Copy
Actions List<GetPlan Rule Copy Action> - Configuration block(s) with copy operation settings. See below.
- Enable
Continuous boolBackup - Whether AWS Backup creates continuous backups.
- Lifecycles
List<Get
Plan Rule Lifecycle> - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- Rule
Name string - Display name of a backup rule.
- Scan
Actions List<GetPlan Rule Scan Action> - Configuration block(s) with malware scanning settings. See below.
- Schedule string
- CRON expression specifying when AWS Backup initiates a backup job.
- Schedule
Expression stringTimezone - Timezone in which the schedule expression is set.
- Start
Window int - Amount of time in minutes before beginning a backup.
- Target
Logically stringAir Gapped Backup Vault Arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- Target
Vault stringName - Name of a logical container where backups are stored.
- Dictionary<string, string>
- Metadata that you can assign to help organize the resources that you create.
- Completion
Window int - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- Copy
Actions []GetPlan Rule Copy Action - Configuration block(s) with copy operation settings. See below.
- Enable
Continuous boolBackup - Whether AWS Backup creates continuous backups.
- Lifecycles
[]Get
Plan Rule Lifecycle - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- Rule
Name string - Display name of a backup rule.
- Scan
Actions []GetPlan Rule Scan Action - Configuration block(s) with malware scanning settings. See below.
- Schedule string
- CRON expression specifying when AWS Backup initiates a backup job.
- Schedule
Expression stringTimezone - Timezone in which the schedule expression is set.
- Start
Window int - Amount of time in minutes before beginning a backup.
- Target
Logically stringAir Gapped Backup Vault Arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- Target
Vault stringName - Name of a logical container where backups are stored.
- map[string]string
- Metadata that you can assign to help organize the resources that you create.
- completion_
window number - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- copy_
actions list(object) - Configuration block(s) with copy operation settings. See below.
- enable_
continuous_ boolbackup - Whether AWS Backup creates continuous backups.
- lifecycles list(object)
- Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- rule_
name string - Display name of a backup rule.
- scan_
actions list(object) - Configuration block(s) with malware scanning settings. See below.
- schedule string
- CRON expression specifying when AWS Backup initiates a backup job.
- schedule_
expression_ stringtimezone - Timezone in which the schedule expression is set.
- start_
window number - Amount of time in minutes before beginning a backup.
- target_
logically_ stringair_ gapped_ backup_ vault_ arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- target_
vault_ stringname - Name of a logical container where backups are stored.
- map(string)
- Metadata that you can assign to help organize the resources that you create.
- completion
Window Integer - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- copy
Actions List<GetPlan Rule Copy Action> - Configuration block(s) with copy operation settings. See below.
- enable
Continuous BooleanBackup - Whether AWS Backup creates continuous backups.
- lifecycles
List<Get
Plan Rule Lifecycle> - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- rule
Name String - Display name of a backup rule.
- scan
Actions List<GetPlan Rule Scan Action> - Configuration block(s) with malware scanning settings. See below.
- schedule String
- CRON expression specifying when AWS Backup initiates a backup job.
- schedule
Expression StringTimezone - Timezone in which the schedule expression is set.
- start
Window Integer - Amount of time in minutes before beginning a backup.
- target
Logically StringAir Gapped Backup Vault Arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- target
Vault StringName - Name of a logical container where backups are stored.
- Map<String,String>
- Metadata that you can assign to help organize the resources that you create.
- completion
Window number - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- copy
Actions GetPlan Rule Copy Action[] - Configuration block(s) with copy operation settings. See below.
- enable
Continuous booleanBackup - Whether AWS Backup creates continuous backups.
- lifecycles
Get
Plan Rule Lifecycle[] - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- rule
Name string - Display name of a backup rule.
- scan
Actions GetPlan Rule Scan Action[] - Configuration block(s) with malware scanning settings. See below.
- schedule string
- CRON expression specifying when AWS Backup initiates a backup job.
- schedule
Expression stringTimezone - Timezone in which the schedule expression is set.
- start
Window number - Amount of time in minutes before beginning a backup.
- target
Logically stringAir Gapped Backup Vault Arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- target
Vault stringName - Name of a logical container where backups are stored.
- {[key: string]: string}
- Metadata that you can assign to help organize the resources that you create.
- completion_
window int - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- copy_
actions Sequence[GetPlan Rule Copy Action] - Configuration block(s) with copy operation settings. See below.
- enable_
continuous_ boolbackup - Whether AWS Backup creates continuous backups.
- lifecycles
Sequence[Get
Plan Rule Lifecycle] - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- rule_
name str - Display name of a backup rule.
- scan_
actions Sequence[GetPlan Rule Scan Action] - Configuration block(s) with malware scanning settings. See below.
- schedule str
- CRON expression specifying when AWS Backup initiates a backup job.
- schedule_
expression_ strtimezone - Timezone in which the schedule expression is set.
- start_
window int - Amount of time in minutes before beginning a backup.
- target_
logically_ strair_ gapped_ backup_ vault_ arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- target_
vault_ strname - Name of a logical container where backups are stored.
- Mapping[str, str]
- Metadata that you can assign to help organize the resources that you create.
- completion
Window Number - Amount of time in minutes AWS Backup attempts a backup before canceling the job and returning an error.
- copy
Actions List<Property Map> - Configuration block(s) with copy operation settings. See below.
- enable
Continuous BooleanBackup - Whether AWS Backup creates continuous backups.
- lifecycles List<Property Map>
- Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- rule
Name String - Display name of a backup rule.
- scan
Actions List<Property Map> - Configuration block(s) with malware scanning settings. See below.
- schedule String
- CRON expression specifying when AWS Backup initiates a backup job.
- schedule
Expression StringTimezone - Timezone in which the schedule expression is set.
- start
Window Number - Amount of time in minutes before beginning a backup.
- target
Logically StringAir Gapped Backup Vault Arn - ARN of the logically air-gapped backup vault where the recovery point is copied.
- target
Vault StringName - Name of a logical container where backups are stored.
- Map<String>
- Metadata that you can assign to help organize the resources that you create.
GetPlanRuleCopyAction
- Destination
Vault stringArn - ARN of the destination backup vault for the copied backup.
- Lifecycles
List<Get
Plan Rule Copy Action Lifecycle> - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- Destination
Vault stringArn - ARN of the destination backup vault for the copied backup.
- Lifecycles
[]Get
Plan Rule Copy Action Lifecycle - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- destination_
vault_ stringarn - ARN of the destination backup vault for the copied backup.
- lifecycles list(object)
- Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- destination
Vault StringArn - ARN of the destination backup vault for the copied backup.
- lifecycles
List<Get
Plan Rule Copy Action Lifecycle> - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- destination
Vault stringArn - ARN of the destination backup vault for the copied backup.
- lifecycles
Get
Plan Rule Copy Action Lifecycle[] - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- destination_
vault_ strarn - ARN of the destination backup vault for the copied backup.
- lifecycles
Sequence[Get
Plan Rule Copy Action Lifecycle] - Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
- destination
Vault StringArn - ARN of the destination backup vault for the copied backup.
- lifecycles List<Property Map>
- Lifecycle defining when a recovery point transitions to cold storage and when it expires. See below.
GetPlanRuleCopyActionLifecycle
- Cold
Storage intAfter - Number of days after creation that a recovery point is moved to cold storage.
- Delete
After int - Number of days after creation that a recovery point is deleted.
- Opt
In boolTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- Cold
Storage intAfter - Number of days after creation that a recovery point is moved to cold storage.
- Delete
After int - Number of days after creation that a recovery point is deleted.
- Opt
In boolTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold_
storage_ numberafter - Number of days after creation that a recovery point is moved to cold storage.
- delete_
after number - Number of days after creation that a recovery point is deleted.
- opt_
in_ boolto_ archive_ for_ supported_ resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage IntegerAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After Integer - Number of days after creation that a recovery point is deleted.
- opt
In BooleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage numberAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After number - Number of days after creation that a recovery point is deleted.
- opt
In booleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold_
storage_ intafter - Number of days after creation that a recovery point is moved to cold storage.
- delete_
after int - Number of days after creation that a recovery point is deleted.
- opt_
in_ boolto_ archive_ for_ supported_ resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage NumberAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After Number - Number of days after creation that a recovery point is deleted.
- opt
In BooleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
GetPlanRuleLifecycle
- Cold
Storage intAfter - Number of days after creation that a recovery point is moved to cold storage.
- Delete
After int - Number of days after creation that a recovery point is deleted.
- Opt
In boolTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- Cold
Storage intAfter - Number of days after creation that a recovery point is moved to cold storage.
- Delete
After int - Number of days after creation that a recovery point is deleted.
- Opt
In boolTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold_
storage_ numberafter - Number of days after creation that a recovery point is moved to cold storage.
- delete_
after number - Number of days after creation that a recovery point is deleted.
- opt_
in_ boolto_ archive_ for_ supported_ resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage IntegerAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After Integer - Number of days after creation that a recovery point is deleted.
- opt
In BooleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage numberAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After number - Number of days after creation that a recovery point is deleted.
- opt
In booleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold_
storage_ intafter - Number of days after creation that a recovery point is moved to cold storage.
- delete_
after int - Number of days after creation that a recovery point is deleted.
- opt_
in_ boolto_ archive_ for_ supported_ resources - Whether the recovery point is transitioned to cold storage for supported resource types.
- cold
Storage NumberAfter - Number of days after creation that a recovery point is moved to cold storage.
- delete
After Number - Number of days after creation that a recovery point is deleted.
- opt
In BooleanTo Archive For Supported Resources - Whether the recovery point is transitioned to cold storage for supported resource types.
GetPlanRuleScanAction
- Malware
Scanner string - Malware scanner used for the scan setting.
- Scan
Mode string - Mode of the malware scan.
- Malware
Scanner string - Malware scanner used for the scan setting.
- Scan
Mode string - Mode of the malware scan.
- malware_
scanner string - Malware scanner used for the scan setting.
- scan_
mode string - Mode of the malware scan.
- malware
Scanner String - Malware scanner used for the scan setting.
- scan
Mode String - Mode of the malware scan.
- malware
Scanner string - Malware scanner used for the scan setting.
- scan
Mode string - Mode of the malware scan.
- malware_
scanner str - Malware scanner used for the scan setting.
- scan_
mode str - Mode of the malware scan.
- malware
Scanner String - Malware scanner used for the scan setting.
- scan
Mode String - Mode of the malware scan.
GetPlanScanSetting
- Malware
Scanner string - Malware scanner used for the scan setting.
- Resource
Types List<string> - Resource types to scan.
- Scanner
Role stringArn - ARN of the IAM role used by the scanner.
- Malware
Scanner string - Malware scanner used for the scan setting.
- Resource
Types []string - Resource types to scan.
- Scanner
Role stringArn - ARN of the IAM role used by the scanner.
- malware_
scanner string - Malware scanner used for the scan setting.
- resource_
types list(string) - Resource types to scan.
- scanner_
role_ stringarn - ARN of the IAM role used by the scanner.
- malware
Scanner String - Malware scanner used for the scan setting.
- resource
Types List<String> - Resource types to scan.
- scanner
Role StringArn - ARN of the IAM role used by the scanner.
- malware
Scanner string - Malware scanner used for the scan setting.
- resource
Types string[] - Resource types to scan.
- scanner
Role stringArn - ARN of the IAM role used by the scanner.
- malware_
scanner str - Malware scanner used for the scan setting.
- resource_
types Sequence[str] - Resource types to scan.
- scanner_
role_ strarn - ARN of the IAM role used by the scanner.
- malware
Scanner String - Malware scanner used for the scan setting.
- resource
Types List<String> - Resource types to scan.
- scanner
Role StringArn - ARN of the IAM role used by the scanner.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
Viewing docs for AWS v7.51.1
published on Friday, Oct 16, 2026 by Pulumi
published on Friday, Oct 16, 2026 by Pulumi