AWS v6.63.0 published on Wednesday, Dec 4, 2024 by Pulumi
aws.backup.getPlan
Explore with Pulumi AI
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/v6/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,
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:
- Plan
Id string - Backup plan ID.
- Dictionary<string, string>
- Metadata that you can assign to help organize the plans you create.
- Plan
Id string - Backup plan ID.
- map[string]string
- Metadata that you can assign to help organize the plans you create.
- plan
Id String - Backup plan ID.
- Map<String,String>
- Metadata that you can assign to help organize the plans you create.
- plan
Id string - Backup plan ID.
- {[key: string]: string}
- Metadata that you can assign to help organize the plans you create.
- plan_
id str - Backup plan ID.
- Mapping[str, str]
- Metadata that you can assign to help organize the plans you create.
- plan
Id String - Backup plan ID.
- 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.
- Plan
Id string - Rules
List<Get
Plan Rule> - Rules of a backup plan.
- 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 - Rules
[]Get
Plan Rule - Rules of a backup plan.
- 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 - rules
List<Get
Plan Rule> - Rules of a backup plan.
- 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 - rules
Get
Plan Rule[] - Rules of a backup plan.
- {[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 - rules
Sequence[Get
Plan Rule] - Rules of a backup plan.
- 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 - rules List<Property Map>
- Rules of a backup plan.
- 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 - Copy
Actions List<GetPlan Rule Copy Action> - Enable
Continuous boolBackup - Lifecycles
List<Get
Plan Rule Lifecycle> - Rule
Name string - Schedule string
- Schedule
Expression stringTimezone - Start
Window int - Target
Vault stringName - Dictionary<string, string>
- Completion
Window int - Copy
Actions []GetPlan Rule Copy Action - Enable
Continuous boolBackup - Lifecycles
[]Get
Plan Rule Lifecycle - Rule
Name string - Schedule string
- Schedule
Expression stringTimezone - Start
Window int - Target
Vault stringName - map[string]string
- completion
Window Integer - copy
Actions List<GetPlan Rule Copy Action> - enable
Continuous BooleanBackup - lifecycles
List<Get
Plan Rule Lifecycle> - rule
Name String - schedule String
- schedule
Expression StringTimezone - start
Window Integer - target
Vault StringName - Map<String,String>
- completion
Window number - copy
Actions GetPlan Rule Copy Action[] - enable
Continuous booleanBackup - lifecycles
Get
Plan Rule Lifecycle[] - rule
Name string - schedule string
- schedule
Expression stringTimezone - start
Window number - target
Vault stringName - {[key: string]: string}
- completion
Window Number - copy
Actions List<Property Map> - enable
Continuous BooleanBackup - lifecycles List<Property Map>
- rule
Name String - schedule String
- schedule
Expression StringTimezone - start
Window Number - target
Vault StringName - Map<String>
GetPlanRuleCopyAction
GetPlanRuleCopyActionLifecycle
- cold
Storage IntegerAfter - delete
After Integer - opt
In BooleanTo Archive For Supported Resources
- cold
Storage numberAfter - delete
After number - opt
In booleanTo Archive For Supported Resources
- cold
Storage NumberAfter - delete
After Number - opt
In BooleanTo Archive For Supported Resources
GetPlanRuleLifecycle
- cold
Storage IntegerAfter - delete
After Integer - opt
In BooleanTo Archive For Supported Resources
- cold
Storage numberAfter - delete
After number - opt
In booleanTo Archive For Supported Resources
- cold
Storage NumberAfter - delete
After Number - opt
In BooleanTo Archive For Supported Resources
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.