Class Plan
Provides an AWS Backup plan resource.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = new Aws.Backup.Plan("example", new Aws.Backup.PlanArgs
{
Rules =
{
new Aws.Backup.Inputs.PlanRuleArgs
{
RuleName = "tf_example_backup_rule",
Schedule = "cron(0 12 * * ? *)",
TargetVaultName = aws_backup_vault.Test.Name,
},
},
});
}
}
Inherited Members
Namespace: Pulumi.Aws.Backup
Assembly: Pulumi.Aws.dll
Syntax
public class Plan : CustomResource
Constructors
View SourcePlan(String, PlanArgs, CustomResourceOptions)
Create a Plan resource with the given unique name, arguments, and options.
Declaration
public Plan(string name, PlanArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| PlanArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceArn
The ARN of the backup plan.
Declaration
public Output<string> Arn { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
The display name of a backup plan.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Rules
A rule object that specifies a scheduled task that is used to back up a selection of resources.
Declaration
public Output<ImmutableArray<PlanRule>> Rules { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableArray<PlanRule>> |
Tags
Metadata that you can assign to help organize the plans you create.
Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>> |
Version
Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.
Declaration
public Output<string> Version { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, PlanState, CustomResourceOptions)
Get an existing Plan resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Plan Get(string name, Input<string> id, PlanState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| PlanState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Plan |