Documentation ¶
Index ¶
- type LookupPlanArgs
- type LookupPlanResult
- type LookupSelectionArgs
- type LookupSelectionResult
- type LookupVaultArgs
- type LookupVaultResult
- type Plan
- type PlanAdvancedBackupSetting
- type PlanAdvancedBackupSettingArgs
- func (PlanAdvancedBackupSettingArgs) ElementType() reflect.Type
- func (i PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutput() PlanAdvancedBackupSettingOutput
- func (i PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingOutput
- type PlanAdvancedBackupSettingArray
- func (PlanAdvancedBackupSettingArray) ElementType() reflect.Type
- func (i PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutput() PlanAdvancedBackupSettingArrayOutput
- func (i PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingArrayOutput
- type PlanAdvancedBackupSettingArrayInput
- type PlanAdvancedBackupSettingArrayOutput
- func (PlanAdvancedBackupSettingArrayOutput) ElementType() reflect.Type
- func (o PlanAdvancedBackupSettingArrayOutput) Index(i pulumi.IntInput) PlanAdvancedBackupSettingOutput
- func (o PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutput() PlanAdvancedBackupSettingArrayOutput
- func (o PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingArrayOutput
- type PlanAdvancedBackupSettingInput
- type PlanAdvancedBackupSettingOutput
- func (o PlanAdvancedBackupSettingOutput) BackupOptions() pulumi.StringMapOutput
- func (PlanAdvancedBackupSettingOutput) ElementType() reflect.Type
- func (o PlanAdvancedBackupSettingOutput) ResourceType() pulumi.StringPtrOutput
- func (o PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutput() PlanAdvancedBackupSettingOutput
- func (o PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingOutput
- type PlanArgs
- type PlanInput
- type PlanOutput
- type PlanRule
- type PlanRuleArgs
- type PlanRuleArray
- type PlanRuleArrayInput
- type PlanRuleArrayOutput
- type PlanRuleCopyAction
- type PlanRuleCopyActionArgs
- type PlanRuleCopyActionArray
- type PlanRuleCopyActionArrayInput
- type PlanRuleCopyActionArrayOutput
- func (PlanRuleCopyActionArrayOutput) ElementType() reflect.Type
- func (o PlanRuleCopyActionArrayOutput) Index(i pulumi.IntInput) PlanRuleCopyActionOutput
- func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput
- func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutputWithContext(ctx context.Context) PlanRuleCopyActionArrayOutput
- type PlanRuleCopyActionInput
- type PlanRuleCopyActionLifecycle
- type PlanRuleCopyActionLifecycleArgs
- func (PlanRuleCopyActionLifecycleArgs) ElementType() reflect.Type
- func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput
- func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput
- func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
- func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
- type PlanRuleCopyActionLifecycleInput
- type PlanRuleCopyActionLifecycleOutput
- func (o PlanRuleCopyActionLifecycleOutput) ColdStorageAfter() pulumi.IntPtrOutput
- func (o PlanRuleCopyActionLifecycleOutput) DeleteAfter() pulumi.IntPtrOutput
- func (PlanRuleCopyActionLifecycleOutput) ElementType() reflect.Type
- func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput
- func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput
- func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
- func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
- type PlanRuleCopyActionLifecyclePtrInput
- type PlanRuleCopyActionLifecyclePtrOutput
- func (o PlanRuleCopyActionLifecyclePtrOutput) ColdStorageAfter() pulumi.IntPtrOutput
- func (o PlanRuleCopyActionLifecyclePtrOutput) DeleteAfter() pulumi.IntPtrOutput
- func (o PlanRuleCopyActionLifecyclePtrOutput) Elem() PlanRuleCopyActionLifecycleOutput
- func (PlanRuleCopyActionLifecyclePtrOutput) ElementType() reflect.Type
- func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
- func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
- type PlanRuleCopyActionOutput
- func (o PlanRuleCopyActionOutput) DestinationVaultArn() pulumi.StringOutput
- func (PlanRuleCopyActionOutput) ElementType() reflect.Type
- func (o PlanRuleCopyActionOutput) Lifecycle() PlanRuleCopyActionLifecyclePtrOutput
- func (o PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput
- func (o PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutputWithContext(ctx context.Context) PlanRuleCopyActionOutput
- type PlanRuleInput
- type PlanRuleLifecycle
- type PlanRuleLifecycleArgs
- func (PlanRuleLifecycleArgs) ElementType() reflect.Type
- func (i PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutput() PlanRuleLifecycleOutput
- func (i PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutputWithContext(ctx context.Context) PlanRuleLifecycleOutput
- func (i PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
- func (i PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
- type PlanRuleLifecycleInput
- type PlanRuleLifecycleOutput
- func (o PlanRuleLifecycleOutput) ColdStorageAfter() pulumi.IntPtrOutput
- func (o PlanRuleLifecycleOutput) DeleteAfter() pulumi.IntPtrOutput
- func (PlanRuleLifecycleOutput) ElementType() reflect.Type
- func (o PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutput() PlanRuleLifecycleOutput
- func (o PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutputWithContext(ctx context.Context) PlanRuleLifecycleOutput
- func (o PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
- func (o PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
- type PlanRuleLifecyclePtrInput
- type PlanRuleLifecyclePtrOutput
- func (o PlanRuleLifecyclePtrOutput) ColdStorageAfter() pulumi.IntPtrOutput
- func (o PlanRuleLifecyclePtrOutput) DeleteAfter() pulumi.IntPtrOutput
- func (o PlanRuleLifecyclePtrOutput) Elem() PlanRuleLifecycleOutput
- func (PlanRuleLifecyclePtrOutput) ElementType() reflect.Type
- func (o PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
- func (o PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
- type PlanRuleOutput
- func (o PlanRuleOutput) CompletionWindow() pulumi.IntPtrOutput
- func (o PlanRuleOutput) CopyActions() PlanRuleCopyActionArrayOutput
- func (PlanRuleOutput) ElementType() reflect.Type
- func (o PlanRuleOutput) Lifecycle() PlanRuleLifecyclePtrOutput
- func (o PlanRuleOutput) RecoveryPointTags() pulumi.StringMapOutput
- func (o PlanRuleOutput) RuleName() pulumi.StringOutput
- func (o PlanRuleOutput) Schedule() pulumi.StringPtrOutput
- func (o PlanRuleOutput) StartWindow() pulumi.IntPtrOutput
- func (o PlanRuleOutput) TargetVaultName() pulumi.StringOutput
- func (o PlanRuleOutput) ToPlanRuleOutput() PlanRuleOutput
- func (o PlanRuleOutput) ToPlanRuleOutputWithContext(ctx context.Context) PlanRuleOutput
- type PlanState
- type Selection
- type SelectionArgs
- type SelectionInput
- type SelectionOutput
- type SelectionSelectionTag
- type SelectionSelectionTagArgs
- type SelectionSelectionTagArray
- func (SelectionSelectionTagArray) ElementType() reflect.Type
- func (i SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutput() SelectionSelectionTagArrayOutput
- func (i SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutputWithContext(ctx context.Context) SelectionSelectionTagArrayOutput
- type SelectionSelectionTagArrayInput
- type SelectionSelectionTagArrayOutput
- func (SelectionSelectionTagArrayOutput) ElementType() reflect.Type
- func (o SelectionSelectionTagArrayOutput) Index(i pulumi.IntInput) SelectionSelectionTagOutput
- func (o SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutput() SelectionSelectionTagArrayOutput
- func (o SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutputWithContext(ctx context.Context) SelectionSelectionTagArrayOutput
- type SelectionSelectionTagInput
- type SelectionSelectionTagOutput
- func (SelectionSelectionTagOutput) ElementType() reflect.Type
- func (o SelectionSelectionTagOutput) Key() pulumi.StringOutput
- func (o SelectionSelectionTagOutput) ToSelectionSelectionTagOutput() SelectionSelectionTagOutput
- func (o SelectionSelectionTagOutput) ToSelectionSelectionTagOutputWithContext(ctx context.Context) SelectionSelectionTagOutput
- func (o SelectionSelectionTagOutput) Type() pulumi.StringOutput
- func (o SelectionSelectionTagOutput) Value() pulumi.StringOutput
- type SelectionState
- type Vault
- type VaultArgs
- type VaultInput
- type VaultNotifications
- type VaultNotificationsArgs
- type VaultNotificationsInput
- type VaultNotificationsOutput
- type VaultNotificationsState
- type VaultOutput
- type VaultPolicy
- type VaultPolicyArgs
- type VaultPolicyInput
- type VaultPolicyOutput
- type VaultPolicyState
- type VaultState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LookupPlanArgs ¶
type LookupPlanArgs struct { // The backup plan ID. PlanId string `pulumi:"planId"` // Metadata that you can assign to help organize the plans you create. Tags map[string]string `pulumi:"tags"` }
A collection of arguments for invoking getPlan.
type LookupPlanResult ¶
type LookupPlanResult struct { // The ARN of the backup plan. Arn string `pulumi:"arn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The display name of a backup plan. Name string `pulumi:"name"` PlanId string `pulumi:"planId"` // Metadata that you can assign to help organize the plans you create. Tags map[string]string `pulumi:"tags"` // Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan. Version string `pulumi:"version"` }
A collection of values returned by getPlan.
func LookupPlan ¶
func LookupPlan(ctx *pulumi.Context, args *LookupPlanArgs, opts ...pulumi.InvokeOption) (*LookupPlanResult, error)
Use this data source to get information on an existing backup plan.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/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 }) }
```
type LookupSelectionArgs ¶
type LookupSelectionArgs struct { // The backup plan ID associated with the selection of resources. PlanId string `pulumi:"planId"` // The backup selection ID. SelectionId string `pulumi:"selectionId"` }
A collection of arguments for invoking getSelection.
type LookupSelectionResult ¶
type LookupSelectionResult struct { // The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. IamRoleArn string `pulumi:"iamRoleArn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The display name of a resource selection document. Name string `pulumi:"name"` PlanId string `pulumi:"planId"` // An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. Resources []string `pulumi:"resources"` SelectionId string `pulumi:"selectionId"` }
A collection of values returned by getSelection.
func LookupSelection ¶
func LookupSelection(ctx *pulumi.Context, args *LookupSelectionArgs, opts ...pulumi.InvokeOption) (*LookupSelectionResult, error)
Use this data source to get information on an existing backup selection.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := backup.LookupSelection(ctx, &backup.LookupSelectionArgs{ PlanId: data.Aws_backup_plan.Example.Id, SelectionId: "selection-id-example", }, nil) if err != nil { return err } return nil }) }
```
type LookupVaultArgs ¶
type LookupVaultArgs struct { // The name of the backup vault. Name string `pulumi:"name"` // Metadata that you can assign to help organize the resources that you create. Tags map[string]string `pulumi:"tags"` }
A collection of arguments for invoking getVault.
type LookupVaultResult ¶
type LookupVaultResult struct { // The ARN of the vault. Arn string `pulumi:"arn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The server-side encryption key that is used to protect your backups. KmsKeyArn string `pulumi:"kmsKeyArn"` Name string `pulumi:"name"` // The number of recovery points that are stored in a backup vault. RecoveryPoints int `pulumi:"recoveryPoints"` // Metadata that you can assign to help organize the resources that you create. Tags map[string]string `pulumi:"tags"` }
A collection of values returned by getVault.
func LookupVault ¶
func LookupVault(ctx *pulumi.Context, args *LookupVaultArgs, opts ...pulumi.InvokeOption) (*LookupVaultResult, error)
Use this data source to get information on an existing backup vault.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := backup.LookupVault(ctx, &backup.LookupVaultArgs{ Name: "example_backup_vault", }, nil) if err != nil { return err } return nil }) }
```
type Plan ¶
type Plan struct { pulumi.CustomResourceState // An object that specifies backup options for each resource type. AdvancedBackupSettings PlanAdvancedBackupSettingArrayOutput `pulumi:"advancedBackupSettings"` // The ARN of the backup plan. Arn pulumi.StringOutput `pulumi:"arn"` // The display name of a backup plan. Name pulumi.StringOutput `pulumi:"name"` // A rule object that specifies a scheduled task that is used to back up a selection of resources. Rules PlanRuleArrayOutput `pulumi:"rules"` // Metadata that you can assign to help organize the plans you create. Tags pulumi.StringMapOutput `pulumi:"tags"` // Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan. Version pulumi.StringOutput `pulumi:"version"` }
Provides an AWS Backup plan resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := backup.NewPlan(ctx, "example", &backup.PlanArgs{ Rules: backup.PlanRuleArray{ &backup.PlanRuleArgs{ RuleName: pulumi.String("tf_example_backup_rule"), TargetVaultName: pulumi.Any(aws_backup_vault.Test.Name), Schedule: pulumi.String("cron(0 12 * * ? *)"), }, }, AdvancedBackupSettings: backup.PlanAdvancedBackupSettingArray{ &backup.PlanAdvancedBackupSettingArgs{ BackupOptions: pulumi.StringMap{ "WindowsVSS": pulumi.String("enabled"), }, ResourceType: pulumi.String("EC2"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Backup Plan can be imported using the `id`, e.g.
```sh
$ pulumi import aws:backup/plan:Plan test <id>
```
func GetPlan ¶
func GetPlan(ctx *pulumi.Context, name string, id pulumi.IDInput, state *PlanState, opts ...pulumi.ResourceOption) (*Plan, error)
GetPlan gets an existing Plan resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPlan ¶
func NewPlan(ctx *pulumi.Context, name string, args *PlanArgs, opts ...pulumi.ResourceOption) (*Plan, error)
NewPlan registers a new resource with the given unique name, arguments, and options.
func (Plan) ElementType ¶ added in v3.13.0
func (Plan) ToPlanOutput ¶ added in v3.13.0
func (i Plan) ToPlanOutput() PlanOutput
func (Plan) ToPlanOutputWithContext ¶ added in v3.13.0
func (i Plan) ToPlanOutputWithContext(ctx context.Context) PlanOutput
type PlanAdvancedBackupSetting ¶ added in v3.8.0
type PlanAdvancedBackupSetting struct { // Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs. Set to `{ WindowsVSS = "enabled" }` to enable Windows VSS backup option and create a VSS Windows backup. BackupOptions map[string]string `pulumi:"backupOptions"` // The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2. Valid values: `EC2`. ResourceType *string `pulumi:"resourceType"` }
type PlanAdvancedBackupSettingArgs ¶ added in v3.8.0
type PlanAdvancedBackupSettingArgs struct { // Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs. Set to `{ WindowsVSS = "enabled" }` to enable Windows VSS backup option and create a VSS Windows backup. BackupOptions pulumi.StringMapInput `pulumi:"backupOptions"` // The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2. Valid values: `EC2`. ResourceType pulumi.StringPtrInput `pulumi:"resourceType"` }
func (PlanAdvancedBackupSettingArgs) ElementType ¶ added in v3.8.0
func (PlanAdvancedBackupSettingArgs) ElementType() reflect.Type
func (PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutput ¶ added in v3.8.0
func (i PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutput() PlanAdvancedBackupSettingOutput
func (PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutputWithContext ¶ added in v3.8.0
func (i PlanAdvancedBackupSettingArgs) ToPlanAdvancedBackupSettingOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingOutput
type PlanAdvancedBackupSettingArray ¶ added in v3.8.0
type PlanAdvancedBackupSettingArray []PlanAdvancedBackupSettingInput
func (PlanAdvancedBackupSettingArray) ElementType ¶ added in v3.8.0
func (PlanAdvancedBackupSettingArray) ElementType() reflect.Type
func (PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutput ¶ added in v3.8.0
func (i PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutput() PlanAdvancedBackupSettingArrayOutput
func (PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutputWithContext ¶ added in v3.8.0
func (i PlanAdvancedBackupSettingArray) ToPlanAdvancedBackupSettingArrayOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingArrayOutput
type PlanAdvancedBackupSettingArrayInput ¶ added in v3.8.0
type PlanAdvancedBackupSettingArrayInput interface { pulumi.Input ToPlanAdvancedBackupSettingArrayOutput() PlanAdvancedBackupSettingArrayOutput ToPlanAdvancedBackupSettingArrayOutputWithContext(context.Context) PlanAdvancedBackupSettingArrayOutput }
PlanAdvancedBackupSettingArrayInput is an input type that accepts PlanAdvancedBackupSettingArray and PlanAdvancedBackupSettingArrayOutput values. You can construct a concrete instance of `PlanAdvancedBackupSettingArrayInput` via:
PlanAdvancedBackupSettingArray{ PlanAdvancedBackupSettingArgs{...} }
type PlanAdvancedBackupSettingArrayOutput ¶ added in v3.8.0
type PlanAdvancedBackupSettingArrayOutput struct{ *pulumi.OutputState }
func (PlanAdvancedBackupSettingArrayOutput) ElementType ¶ added in v3.8.0
func (PlanAdvancedBackupSettingArrayOutput) ElementType() reflect.Type
func (PlanAdvancedBackupSettingArrayOutput) Index ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingArrayOutput) Index(i pulumi.IntInput) PlanAdvancedBackupSettingOutput
func (PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutput ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutput() PlanAdvancedBackupSettingArrayOutput
func (PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutputWithContext ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingArrayOutput) ToPlanAdvancedBackupSettingArrayOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingArrayOutput
type PlanAdvancedBackupSettingInput ¶ added in v3.8.0
type PlanAdvancedBackupSettingInput interface { pulumi.Input ToPlanAdvancedBackupSettingOutput() PlanAdvancedBackupSettingOutput ToPlanAdvancedBackupSettingOutputWithContext(context.Context) PlanAdvancedBackupSettingOutput }
PlanAdvancedBackupSettingInput is an input type that accepts PlanAdvancedBackupSettingArgs and PlanAdvancedBackupSettingOutput values. You can construct a concrete instance of `PlanAdvancedBackupSettingInput` via:
PlanAdvancedBackupSettingArgs{...}
type PlanAdvancedBackupSettingOutput ¶ added in v3.8.0
type PlanAdvancedBackupSettingOutput struct{ *pulumi.OutputState }
func (PlanAdvancedBackupSettingOutput) BackupOptions ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingOutput) BackupOptions() pulumi.StringMapOutput
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs. Set to `{ WindowsVSS = "enabled" }` to enable Windows VSS backup option and create a VSS Windows backup.
func (PlanAdvancedBackupSettingOutput) ElementType ¶ added in v3.8.0
func (PlanAdvancedBackupSettingOutput) ElementType() reflect.Type
func (PlanAdvancedBackupSettingOutput) ResourceType ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingOutput) ResourceType() pulumi.StringPtrOutput
The type of AWS resource to be backed up. For VSS Windows backups, the only supported resource type is Amazon EC2. Valid values: `EC2`.
func (PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutput ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutput() PlanAdvancedBackupSettingOutput
func (PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutputWithContext ¶ added in v3.8.0
func (o PlanAdvancedBackupSettingOutput) ToPlanAdvancedBackupSettingOutputWithContext(ctx context.Context) PlanAdvancedBackupSettingOutput
type PlanArgs ¶
type PlanArgs struct { // An object that specifies backup options for each resource type. AdvancedBackupSettings PlanAdvancedBackupSettingArrayInput // The display name of a backup plan. Name pulumi.StringPtrInput // A rule object that specifies a scheduled task that is used to back up a selection of resources. Rules PlanRuleArrayInput // Metadata that you can assign to help organize the plans you create. Tags pulumi.StringMapInput }
The set of arguments for constructing a Plan resource.
func (PlanArgs) ElementType ¶
type PlanInput ¶ added in v3.13.0
type PlanInput interface { pulumi.Input ToPlanOutput() PlanOutput ToPlanOutputWithContext(ctx context.Context) PlanOutput }
type PlanOutput ¶ added in v3.13.0
type PlanOutput struct {
*pulumi.OutputState
}
func (PlanOutput) ElementType ¶ added in v3.13.0
func (PlanOutput) ElementType() reflect.Type
func (PlanOutput) ToPlanOutput ¶ added in v3.13.0
func (o PlanOutput) ToPlanOutput() PlanOutput
func (PlanOutput) ToPlanOutputWithContext ¶ added in v3.13.0
func (o PlanOutput) ToPlanOutputWithContext(ctx context.Context) PlanOutput
type PlanRule ¶
type PlanRule struct { // The amount of time AWS Backup attempts a backup before canceling the job and returning an error. CompletionWindow *int `pulumi:"completionWindow"` // Configuration block(s) with copy operation settings. Detailed below. CopyActions []PlanRuleCopyAction `pulumi:"copyActions"` // The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above. Lifecycle *PlanRuleLifecycle `pulumi:"lifecycle"` // Metadata that you can assign to help organize the resources that you create. RecoveryPointTags map[string]string `pulumi:"recoveryPointTags"` // An display name for a backup rule. RuleName string `pulumi:"ruleName"` // A CRON expression specifying when AWS Backup initiates a backup job. Schedule *string `pulumi:"schedule"` // The amount of time in minutes before beginning a backup. StartWindow *int `pulumi:"startWindow"` // The name of a logical container where backups are stored. TargetVaultName string `pulumi:"targetVaultName"` }
type PlanRuleArgs ¶
type PlanRuleArgs struct { // The amount of time AWS Backup attempts a backup before canceling the job and returning an error. CompletionWindow pulumi.IntPtrInput `pulumi:"completionWindow"` // Configuration block(s) with copy operation settings. Detailed below. CopyActions PlanRuleCopyActionArrayInput `pulumi:"copyActions"` // The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above. Lifecycle PlanRuleLifecyclePtrInput `pulumi:"lifecycle"` // Metadata that you can assign to help organize the resources that you create. RecoveryPointTags pulumi.StringMapInput `pulumi:"recoveryPointTags"` // An display name for a backup rule. RuleName pulumi.StringInput `pulumi:"ruleName"` // A CRON expression specifying when AWS Backup initiates a backup job. Schedule pulumi.StringPtrInput `pulumi:"schedule"` // The amount of time in minutes before beginning a backup. StartWindow pulumi.IntPtrInput `pulumi:"startWindow"` // The name of a logical container where backups are stored. TargetVaultName pulumi.StringInput `pulumi:"targetVaultName"` }
func (PlanRuleArgs) ElementType ¶
func (PlanRuleArgs) ElementType() reflect.Type
func (PlanRuleArgs) ToPlanRuleOutput ¶
func (i PlanRuleArgs) ToPlanRuleOutput() PlanRuleOutput
func (PlanRuleArgs) ToPlanRuleOutputWithContext ¶
func (i PlanRuleArgs) ToPlanRuleOutputWithContext(ctx context.Context) PlanRuleOutput
type PlanRuleArray ¶
type PlanRuleArray []PlanRuleInput
func (PlanRuleArray) ElementType ¶
func (PlanRuleArray) ElementType() reflect.Type
func (PlanRuleArray) ToPlanRuleArrayOutput ¶
func (i PlanRuleArray) ToPlanRuleArrayOutput() PlanRuleArrayOutput
func (PlanRuleArray) ToPlanRuleArrayOutputWithContext ¶
func (i PlanRuleArray) ToPlanRuleArrayOutputWithContext(ctx context.Context) PlanRuleArrayOutput
type PlanRuleArrayInput ¶
type PlanRuleArrayInput interface { pulumi.Input ToPlanRuleArrayOutput() PlanRuleArrayOutput ToPlanRuleArrayOutputWithContext(context.Context) PlanRuleArrayOutput }
PlanRuleArrayInput is an input type that accepts PlanRuleArray and PlanRuleArrayOutput values. You can construct a concrete instance of `PlanRuleArrayInput` via:
PlanRuleArray{ PlanRuleArgs{...} }
type PlanRuleArrayOutput ¶
type PlanRuleArrayOutput struct{ *pulumi.OutputState }
func (PlanRuleArrayOutput) ElementType ¶
func (PlanRuleArrayOutput) ElementType() reflect.Type
func (PlanRuleArrayOutput) Index ¶
func (o PlanRuleArrayOutput) Index(i pulumi.IntInput) PlanRuleOutput
func (PlanRuleArrayOutput) ToPlanRuleArrayOutput ¶
func (o PlanRuleArrayOutput) ToPlanRuleArrayOutput() PlanRuleArrayOutput
func (PlanRuleArrayOutput) ToPlanRuleArrayOutputWithContext ¶
func (o PlanRuleArrayOutput) ToPlanRuleArrayOutputWithContext(ctx context.Context) PlanRuleArrayOutput
type PlanRuleCopyAction ¶
type PlanRuleCopyAction struct { // An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. DestinationVaultArn string `pulumi:"destinationVaultArn"` // The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above. Lifecycle *PlanRuleCopyActionLifecycle `pulumi:"lifecycle"` }
type PlanRuleCopyActionArgs ¶
type PlanRuleCopyActionArgs struct { // An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. DestinationVaultArn pulumi.StringInput `pulumi:"destinationVaultArn"` // The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above. Lifecycle PlanRuleCopyActionLifecyclePtrInput `pulumi:"lifecycle"` }
func (PlanRuleCopyActionArgs) ElementType ¶
func (PlanRuleCopyActionArgs) ElementType() reflect.Type
func (PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutput ¶
func (i PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput
func (PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutputWithContext ¶
func (i PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutputWithContext(ctx context.Context) PlanRuleCopyActionOutput
type PlanRuleCopyActionArray ¶
type PlanRuleCopyActionArray []PlanRuleCopyActionInput
func (PlanRuleCopyActionArray) ElementType ¶
func (PlanRuleCopyActionArray) ElementType() reflect.Type
func (PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutput ¶
func (i PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput
func (PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutputWithContext ¶
func (i PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutputWithContext(ctx context.Context) PlanRuleCopyActionArrayOutput
type PlanRuleCopyActionArrayInput ¶
type PlanRuleCopyActionArrayInput interface { pulumi.Input ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput ToPlanRuleCopyActionArrayOutputWithContext(context.Context) PlanRuleCopyActionArrayOutput }
PlanRuleCopyActionArrayInput is an input type that accepts PlanRuleCopyActionArray and PlanRuleCopyActionArrayOutput values. You can construct a concrete instance of `PlanRuleCopyActionArrayInput` via:
PlanRuleCopyActionArray{ PlanRuleCopyActionArgs{...} }
type PlanRuleCopyActionArrayOutput ¶
type PlanRuleCopyActionArrayOutput struct{ *pulumi.OutputState }
func (PlanRuleCopyActionArrayOutput) ElementType ¶
func (PlanRuleCopyActionArrayOutput) ElementType() reflect.Type
func (PlanRuleCopyActionArrayOutput) Index ¶
func (o PlanRuleCopyActionArrayOutput) Index(i pulumi.IntInput) PlanRuleCopyActionOutput
func (PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutput ¶
func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput
func (PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutputWithContext ¶
func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutputWithContext(ctx context.Context) PlanRuleCopyActionArrayOutput
type PlanRuleCopyActionInput ¶
type PlanRuleCopyActionInput interface { pulumi.Input ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput ToPlanRuleCopyActionOutputWithContext(context.Context) PlanRuleCopyActionOutput }
PlanRuleCopyActionInput is an input type that accepts PlanRuleCopyActionArgs and PlanRuleCopyActionOutput values. You can construct a concrete instance of `PlanRuleCopyActionInput` via:
PlanRuleCopyActionArgs{...}
type PlanRuleCopyActionLifecycle ¶
type PlanRuleCopyActionLifecycle struct { // Specifies the number of days after creation that a recovery point is moved to cold storage. ColdStorageAfter *int `pulumi:"coldStorageAfter"` // Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`. DeleteAfter *int `pulumi:"deleteAfter"` }
type PlanRuleCopyActionLifecycleArgs ¶
type PlanRuleCopyActionLifecycleArgs struct { // Specifies the number of days after creation that a recovery point is moved to cold storage. ColdStorageAfter pulumi.IntPtrInput `pulumi:"coldStorageAfter"` // Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`. DeleteAfter pulumi.IntPtrInput `pulumi:"deleteAfter"` }
func (PlanRuleCopyActionLifecycleArgs) ElementType ¶
func (PlanRuleCopyActionLifecycleArgs) ElementType() reflect.Type
func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutput ¶
func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput
func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutputWithContext ¶
func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput
func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutput ¶
func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutputWithContext ¶
func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
type PlanRuleCopyActionLifecycleInput ¶
type PlanRuleCopyActionLifecycleInput interface { pulumi.Input ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput ToPlanRuleCopyActionLifecycleOutputWithContext(context.Context) PlanRuleCopyActionLifecycleOutput }
PlanRuleCopyActionLifecycleInput is an input type that accepts PlanRuleCopyActionLifecycleArgs and PlanRuleCopyActionLifecycleOutput values. You can construct a concrete instance of `PlanRuleCopyActionLifecycleInput` via:
PlanRuleCopyActionLifecycleArgs{...}
type PlanRuleCopyActionLifecycleOutput ¶
type PlanRuleCopyActionLifecycleOutput struct{ *pulumi.OutputState }
func (PlanRuleCopyActionLifecycleOutput) ColdStorageAfter ¶
func (o PlanRuleCopyActionLifecycleOutput) ColdStorageAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is moved to cold storage.
func (PlanRuleCopyActionLifecycleOutput) DeleteAfter ¶
func (o PlanRuleCopyActionLifecycleOutput) DeleteAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`.
func (PlanRuleCopyActionLifecycleOutput) ElementType ¶
func (PlanRuleCopyActionLifecycleOutput) ElementType() reflect.Type
func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutput ¶
func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput
func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutputWithContext ¶
func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput
func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutput ¶
func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext ¶
func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
type PlanRuleCopyActionLifecyclePtrInput ¶
type PlanRuleCopyActionLifecyclePtrInput interface { pulumi.Input ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput ToPlanRuleCopyActionLifecyclePtrOutputWithContext(context.Context) PlanRuleCopyActionLifecyclePtrOutput }
PlanRuleCopyActionLifecyclePtrInput is an input type that accepts PlanRuleCopyActionLifecycleArgs, PlanRuleCopyActionLifecyclePtr and PlanRuleCopyActionLifecyclePtrOutput values. You can construct a concrete instance of `PlanRuleCopyActionLifecyclePtrInput` via:
PlanRuleCopyActionLifecycleArgs{...} or: nil
func PlanRuleCopyActionLifecyclePtr ¶
func PlanRuleCopyActionLifecyclePtr(v *PlanRuleCopyActionLifecycleArgs) PlanRuleCopyActionLifecyclePtrInput
type PlanRuleCopyActionLifecyclePtrOutput ¶
type PlanRuleCopyActionLifecyclePtrOutput struct{ *pulumi.OutputState }
func (PlanRuleCopyActionLifecyclePtrOutput) ColdStorageAfter ¶
func (o PlanRuleCopyActionLifecyclePtrOutput) ColdStorageAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is moved to cold storage.
func (PlanRuleCopyActionLifecyclePtrOutput) DeleteAfter ¶
func (o PlanRuleCopyActionLifecyclePtrOutput) DeleteAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`.
func (PlanRuleCopyActionLifecyclePtrOutput) ElementType ¶
func (PlanRuleCopyActionLifecyclePtrOutput) ElementType() reflect.Type
func (PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutput ¶
func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput
func (PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext ¶
func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput
type PlanRuleCopyActionOutput ¶
type PlanRuleCopyActionOutput struct{ *pulumi.OutputState }
func (PlanRuleCopyActionOutput) DestinationVaultArn ¶
func (o PlanRuleCopyActionOutput) DestinationVaultArn() pulumi.StringOutput
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.
func (PlanRuleCopyActionOutput) ElementType ¶
func (PlanRuleCopyActionOutput) ElementType() reflect.Type
func (PlanRuleCopyActionOutput) Lifecycle ¶
func (o PlanRuleCopyActionOutput) Lifecycle() PlanRuleCopyActionLifecyclePtrOutput
The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above.
func (PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutput ¶
func (o PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput
func (PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutputWithContext ¶
func (o PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutputWithContext(ctx context.Context) PlanRuleCopyActionOutput
type PlanRuleInput ¶
type PlanRuleInput interface { pulumi.Input ToPlanRuleOutput() PlanRuleOutput ToPlanRuleOutputWithContext(context.Context) PlanRuleOutput }
PlanRuleInput is an input type that accepts PlanRuleArgs and PlanRuleOutput values. You can construct a concrete instance of `PlanRuleInput` via:
PlanRuleArgs{...}
type PlanRuleLifecycle ¶
type PlanRuleLifecycle struct { // Specifies the number of days after creation that a recovery point is moved to cold storage. ColdStorageAfter *int `pulumi:"coldStorageAfter"` // Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`. DeleteAfter *int `pulumi:"deleteAfter"` }
type PlanRuleLifecycleArgs ¶
type PlanRuleLifecycleArgs struct { // Specifies the number of days after creation that a recovery point is moved to cold storage. ColdStorageAfter pulumi.IntPtrInput `pulumi:"coldStorageAfter"` // Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`. DeleteAfter pulumi.IntPtrInput `pulumi:"deleteAfter"` }
func (PlanRuleLifecycleArgs) ElementType ¶
func (PlanRuleLifecycleArgs) ElementType() reflect.Type
func (PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutput ¶
func (i PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutput() PlanRuleLifecycleOutput
func (PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutputWithContext ¶
func (i PlanRuleLifecycleArgs) ToPlanRuleLifecycleOutputWithContext(ctx context.Context) PlanRuleLifecycleOutput
func (PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutput ¶
func (i PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
func (PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutputWithContext ¶
func (i PlanRuleLifecycleArgs) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
type PlanRuleLifecycleInput ¶
type PlanRuleLifecycleInput interface { pulumi.Input ToPlanRuleLifecycleOutput() PlanRuleLifecycleOutput ToPlanRuleLifecycleOutputWithContext(context.Context) PlanRuleLifecycleOutput }
PlanRuleLifecycleInput is an input type that accepts PlanRuleLifecycleArgs and PlanRuleLifecycleOutput values. You can construct a concrete instance of `PlanRuleLifecycleInput` via:
PlanRuleLifecycleArgs{...}
type PlanRuleLifecycleOutput ¶
type PlanRuleLifecycleOutput struct{ *pulumi.OutputState }
func (PlanRuleLifecycleOutput) ColdStorageAfter ¶
func (o PlanRuleLifecycleOutput) ColdStorageAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is moved to cold storage.
func (PlanRuleLifecycleOutput) DeleteAfter ¶
func (o PlanRuleLifecycleOutput) DeleteAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`.
func (PlanRuleLifecycleOutput) ElementType ¶
func (PlanRuleLifecycleOutput) ElementType() reflect.Type
func (PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutput ¶
func (o PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutput() PlanRuleLifecycleOutput
func (PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutputWithContext ¶
func (o PlanRuleLifecycleOutput) ToPlanRuleLifecycleOutputWithContext(ctx context.Context) PlanRuleLifecycleOutput
func (PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutput ¶
func (o PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
func (PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutputWithContext ¶
func (o PlanRuleLifecycleOutput) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
type PlanRuleLifecyclePtrInput ¶
type PlanRuleLifecyclePtrInput interface { pulumi.Input ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput ToPlanRuleLifecyclePtrOutputWithContext(context.Context) PlanRuleLifecyclePtrOutput }
PlanRuleLifecyclePtrInput is an input type that accepts PlanRuleLifecycleArgs, PlanRuleLifecyclePtr and PlanRuleLifecyclePtrOutput values. You can construct a concrete instance of `PlanRuleLifecyclePtrInput` via:
PlanRuleLifecycleArgs{...} or: nil
func PlanRuleLifecyclePtr ¶
func PlanRuleLifecyclePtr(v *PlanRuleLifecycleArgs) PlanRuleLifecyclePtrInput
type PlanRuleLifecyclePtrOutput ¶
type PlanRuleLifecyclePtrOutput struct{ *pulumi.OutputState }
func (PlanRuleLifecyclePtrOutput) ColdStorageAfter ¶
func (o PlanRuleLifecyclePtrOutput) ColdStorageAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is moved to cold storage.
func (PlanRuleLifecyclePtrOutput) DeleteAfter ¶
func (o PlanRuleLifecyclePtrOutput) DeleteAfter() pulumi.IntPtrOutput
Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than `coldStorageAfter`.
func (PlanRuleLifecyclePtrOutput) Elem ¶
func (o PlanRuleLifecyclePtrOutput) Elem() PlanRuleLifecycleOutput
func (PlanRuleLifecyclePtrOutput) ElementType ¶
func (PlanRuleLifecyclePtrOutput) ElementType() reflect.Type
func (PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutput ¶
func (o PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutput() PlanRuleLifecyclePtrOutput
func (PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutputWithContext ¶
func (o PlanRuleLifecyclePtrOutput) ToPlanRuleLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleLifecyclePtrOutput
type PlanRuleOutput ¶
type PlanRuleOutput struct{ *pulumi.OutputState }
func (PlanRuleOutput) CompletionWindow ¶
func (o PlanRuleOutput) CompletionWindow() pulumi.IntPtrOutput
The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
func (PlanRuleOutput) CopyActions ¶
func (o PlanRuleOutput) CopyActions() PlanRuleCopyActionArrayOutput
Configuration block(s) with copy operation settings. Detailed below.
func (PlanRuleOutput) ElementType ¶
func (PlanRuleOutput) ElementType() reflect.Type
func (PlanRuleOutput) Lifecycle ¶
func (o PlanRuleOutput) Lifecycle() PlanRuleLifecyclePtrOutput
The lifecycle defines when a protected resource is copied over to a backup vault and when it expires. Fields documented above.
func (PlanRuleOutput) RecoveryPointTags ¶
func (o PlanRuleOutput) RecoveryPointTags() pulumi.StringMapOutput
Metadata that you can assign to help organize the resources that you create.
func (PlanRuleOutput) RuleName ¶
func (o PlanRuleOutput) RuleName() pulumi.StringOutput
An display name for a backup rule.
func (PlanRuleOutput) Schedule ¶
func (o PlanRuleOutput) Schedule() pulumi.StringPtrOutput
A CRON expression specifying when AWS Backup initiates a backup job.
func (PlanRuleOutput) StartWindow ¶
func (o PlanRuleOutput) StartWindow() pulumi.IntPtrOutput
The amount of time in minutes before beginning a backup.
func (PlanRuleOutput) TargetVaultName ¶
func (o PlanRuleOutput) TargetVaultName() pulumi.StringOutput
The name of a logical container where backups are stored.
func (PlanRuleOutput) ToPlanRuleOutput ¶
func (o PlanRuleOutput) ToPlanRuleOutput() PlanRuleOutput
func (PlanRuleOutput) ToPlanRuleOutputWithContext ¶
func (o PlanRuleOutput) ToPlanRuleOutputWithContext(ctx context.Context) PlanRuleOutput
type PlanState ¶
type PlanState struct { // An object that specifies backup options for each resource type. AdvancedBackupSettings PlanAdvancedBackupSettingArrayInput // The ARN of the backup plan. Arn pulumi.StringPtrInput // The display name of a backup plan. Name pulumi.StringPtrInput // A rule object that specifies a scheduled task that is used to back up a selection of resources. Rules PlanRuleArrayInput // Metadata that you can assign to help organize the plans you create. Tags pulumi.StringMapInput // Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan. Version pulumi.StringPtrInput }
func (PlanState) ElementType ¶
type Selection ¶
type Selection struct { pulumi.CustomResourceState // The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. IamRoleArn pulumi.StringOutput `pulumi:"iamRoleArn"` // The display name of a resource selection document. Name pulumi.StringOutput `pulumi:"name"` // The backup plan ID to be associated with the selection of resources. PlanId pulumi.StringOutput `pulumi:"planId"` // An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. Resources pulumi.StringArrayOutput `pulumi:"resources"` // Tag-based conditions used to specify a set of resources to assign to a backup plan. SelectionTags SelectionSelectionTagArrayOutput `pulumi:"selectionTags"` }
Manages selection conditions for AWS Backup plan resources.
## Example Usage ### IAM Role
> For more information about creating and managing IAM Roles for backups and restores, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/iam-service-roles.html).
The below example creates an IAM role with the default managed IAM Policy for allowing AWS Backup to create backups.
```go package main
import (
"fmt" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleRole, err := iam.NewRole(ctx, "exampleRole", &iam.RoleArgs{ AssumeRolePolicy: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Version\": \"2012-10-17\",\n", " \"Statement\": [\n", " {\n", " \"Action\": [\"sts:AssumeRole\"],\n", " \"Effect\": \"allow\",\n", " \"Principal\": {\n", " \"Service\": [\"backup.amazonaws.com\"]\n", " }\n", " }\n", " ]\n", "}\n")), }) if err != nil { return err } _, err = iam.NewRolePolicyAttachment(ctx, "exampleRolePolicyAttachment", &iam.RolePolicyAttachmentArgs{ PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AWSBackupServiceRolePolicyForBackup"), Role: exampleRole.Name, }) if err != nil { return err } _, err = backup.NewSelection(ctx, "exampleSelection", &backup.SelectionArgs{ IamRoleArn: exampleRole.Arn, }) if err != nil { return err } return nil }) }
``` ### Selecting Backups By Tag
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := backup.NewSelection(ctx, "example", &backup.SelectionArgs{ IamRoleArn: pulumi.Any(aws_iam_role.Example.Arn), PlanId: pulumi.Any(aws_backup_plan.Example.Id), SelectionTags: backup.SelectionSelectionTagArray{ &backup.SelectionSelectionTagArgs{ Type: pulumi.String("STRINGEQUALS"), Key: pulumi.String("foo"), Value: pulumi.String("bar"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Backup selection can be imported using the role plan_id and id separated by `|`.
```sh
$ pulumi import aws:backup/selection:Selection example plan-id|selection-id
```
func GetSelection ¶
func GetSelection(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SelectionState, opts ...pulumi.ResourceOption) (*Selection, error)
GetSelection gets an existing Selection resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSelection ¶
func NewSelection(ctx *pulumi.Context, name string, args *SelectionArgs, opts ...pulumi.ResourceOption) (*Selection, error)
NewSelection registers a new resource with the given unique name, arguments, and options.
func (Selection) ElementType ¶ added in v3.13.0
func (Selection) ToSelectionOutput ¶ added in v3.13.0
func (i Selection) ToSelectionOutput() SelectionOutput
func (Selection) ToSelectionOutputWithContext ¶ added in v3.13.0
func (i Selection) ToSelectionOutputWithContext(ctx context.Context) SelectionOutput
type SelectionArgs ¶
type SelectionArgs struct { // The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. IamRoleArn pulumi.StringInput // The display name of a resource selection document. Name pulumi.StringPtrInput // The backup plan ID to be associated with the selection of resources. PlanId pulumi.StringInput // An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. Resources pulumi.StringArrayInput // Tag-based conditions used to specify a set of resources to assign to a backup plan. SelectionTags SelectionSelectionTagArrayInput }
The set of arguments for constructing a Selection resource.
func (SelectionArgs) ElementType ¶
func (SelectionArgs) ElementType() reflect.Type
type SelectionInput ¶ added in v3.13.0
type SelectionInput interface { pulumi.Input ToSelectionOutput() SelectionOutput ToSelectionOutputWithContext(ctx context.Context) SelectionOutput }
type SelectionOutput ¶ added in v3.13.0
type SelectionOutput struct {
*pulumi.OutputState
}
func (SelectionOutput) ElementType ¶ added in v3.13.0
func (SelectionOutput) ElementType() reflect.Type
func (SelectionOutput) ToSelectionOutput ¶ added in v3.13.0
func (o SelectionOutput) ToSelectionOutput() SelectionOutput
func (SelectionOutput) ToSelectionOutputWithContext ¶ added in v3.13.0
func (o SelectionOutput) ToSelectionOutputWithContext(ctx context.Context) SelectionOutput
type SelectionSelectionTag ¶
type SelectionSelectionTag struct { // The key in a key-value pair. Key string `pulumi:"key"` // An operation, such as `StringEquals`, that is applied to a key-value pair used to filter resources in a selection. Type string `pulumi:"type"` // The value in a key-value pair. Value string `pulumi:"value"` }
type SelectionSelectionTagArgs ¶
type SelectionSelectionTagArgs struct { // The key in a key-value pair. Key pulumi.StringInput `pulumi:"key"` // An operation, such as `StringEquals`, that is applied to a key-value pair used to filter resources in a selection. Type pulumi.StringInput `pulumi:"type"` // The value in a key-value pair. Value pulumi.StringInput `pulumi:"value"` }
func (SelectionSelectionTagArgs) ElementType ¶
func (SelectionSelectionTagArgs) ElementType() reflect.Type
func (SelectionSelectionTagArgs) ToSelectionSelectionTagOutput ¶
func (i SelectionSelectionTagArgs) ToSelectionSelectionTagOutput() SelectionSelectionTagOutput
func (SelectionSelectionTagArgs) ToSelectionSelectionTagOutputWithContext ¶
func (i SelectionSelectionTagArgs) ToSelectionSelectionTagOutputWithContext(ctx context.Context) SelectionSelectionTagOutput
type SelectionSelectionTagArray ¶
type SelectionSelectionTagArray []SelectionSelectionTagInput
func (SelectionSelectionTagArray) ElementType ¶
func (SelectionSelectionTagArray) ElementType() reflect.Type
func (SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutput ¶
func (i SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutput() SelectionSelectionTagArrayOutput
func (SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutputWithContext ¶
func (i SelectionSelectionTagArray) ToSelectionSelectionTagArrayOutputWithContext(ctx context.Context) SelectionSelectionTagArrayOutput
type SelectionSelectionTagArrayInput ¶
type SelectionSelectionTagArrayInput interface { pulumi.Input ToSelectionSelectionTagArrayOutput() SelectionSelectionTagArrayOutput ToSelectionSelectionTagArrayOutputWithContext(context.Context) SelectionSelectionTagArrayOutput }
SelectionSelectionTagArrayInput is an input type that accepts SelectionSelectionTagArray and SelectionSelectionTagArrayOutput values. You can construct a concrete instance of `SelectionSelectionTagArrayInput` via:
SelectionSelectionTagArray{ SelectionSelectionTagArgs{...} }
type SelectionSelectionTagArrayOutput ¶
type SelectionSelectionTagArrayOutput struct{ *pulumi.OutputState }
func (SelectionSelectionTagArrayOutput) ElementType ¶
func (SelectionSelectionTagArrayOutput) ElementType() reflect.Type
func (SelectionSelectionTagArrayOutput) Index ¶
func (o SelectionSelectionTagArrayOutput) Index(i pulumi.IntInput) SelectionSelectionTagOutput
func (SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutput ¶
func (o SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutput() SelectionSelectionTagArrayOutput
func (SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutputWithContext ¶
func (o SelectionSelectionTagArrayOutput) ToSelectionSelectionTagArrayOutputWithContext(ctx context.Context) SelectionSelectionTagArrayOutput
type SelectionSelectionTagInput ¶
type SelectionSelectionTagInput interface { pulumi.Input ToSelectionSelectionTagOutput() SelectionSelectionTagOutput ToSelectionSelectionTagOutputWithContext(context.Context) SelectionSelectionTagOutput }
SelectionSelectionTagInput is an input type that accepts SelectionSelectionTagArgs and SelectionSelectionTagOutput values. You can construct a concrete instance of `SelectionSelectionTagInput` via:
SelectionSelectionTagArgs{...}
type SelectionSelectionTagOutput ¶
type SelectionSelectionTagOutput struct{ *pulumi.OutputState }
func (SelectionSelectionTagOutput) ElementType ¶
func (SelectionSelectionTagOutput) ElementType() reflect.Type
func (SelectionSelectionTagOutput) Key ¶
func (o SelectionSelectionTagOutput) Key() pulumi.StringOutput
The key in a key-value pair.
func (SelectionSelectionTagOutput) ToSelectionSelectionTagOutput ¶
func (o SelectionSelectionTagOutput) ToSelectionSelectionTagOutput() SelectionSelectionTagOutput
func (SelectionSelectionTagOutput) ToSelectionSelectionTagOutputWithContext ¶
func (o SelectionSelectionTagOutput) ToSelectionSelectionTagOutputWithContext(ctx context.Context) SelectionSelectionTagOutput
func (SelectionSelectionTagOutput) Type ¶
func (o SelectionSelectionTagOutput) Type() pulumi.StringOutput
An operation, such as `StringEquals`, that is applied to a key-value pair used to filter resources in a selection.
func (SelectionSelectionTagOutput) Value ¶
func (o SelectionSelectionTagOutput) Value() pulumi.StringOutput
The value in a key-value pair.
type SelectionState ¶
type SelectionState struct { // The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. IamRoleArn pulumi.StringPtrInput // The display name of a resource selection document. Name pulumi.StringPtrInput // The backup plan ID to be associated with the selection of resources. PlanId pulumi.StringPtrInput // An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. Resources pulumi.StringArrayInput // Tag-based conditions used to specify a set of resources to assign to a backup plan. SelectionTags SelectionSelectionTagArrayInput }
func (SelectionState) ElementType ¶
func (SelectionState) ElementType() reflect.Type
type Vault ¶
type Vault struct { pulumi.CustomResourceState // The ARN of the vault. Arn pulumi.StringOutput `pulumi:"arn"` // The server-side encryption key that is used to protect your backups. KmsKeyArn pulumi.StringOutput `pulumi:"kmsKeyArn"` // Name of the backup vault to create. Name pulumi.StringOutput `pulumi:"name"` // The number of recovery points that are stored in a backup vault. RecoveryPoints pulumi.IntOutput `pulumi:"recoveryPoints"` // Metadata that you can assign to help organize the resources that you create. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Provides an AWS Backup vault resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := backup.NewVault(ctx, "example", &backup.VaultArgs{ KmsKeyArn: pulumi.Any(aws_kms_key.Example.Arn), }) if err != nil { return err } return nil }) }
```
## Import
Backup vault can be imported using the `name`, e.g.
```sh
$ pulumi import aws:backup/vault:Vault test-vault TestVault
```
func GetVault ¶
func GetVault(ctx *pulumi.Context, name string, id pulumi.IDInput, state *VaultState, opts ...pulumi.ResourceOption) (*Vault, error)
GetVault gets an existing Vault resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewVault ¶
func NewVault(ctx *pulumi.Context, name string, args *VaultArgs, opts ...pulumi.ResourceOption) (*Vault, error)
NewVault registers a new resource with the given unique name, arguments, and options.
func (Vault) ElementType ¶ added in v3.13.0
func (Vault) ToVaultOutput ¶ added in v3.13.0
func (i Vault) ToVaultOutput() VaultOutput
func (Vault) ToVaultOutputWithContext ¶ added in v3.13.0
func (i Vault) ToVaultOutputWithContext(ctx context.Context) VaultOutput
type VaultArgs ¶
type VaultArgs struct { // The server-side encryption key that is used to protect your backups. KmsKeyArn pulumi.StringPtrInput // Name of the backup vault to create. Name pulumi.StringPtrInput // Metadata that you can assign to help organize the resources that you create. Tags pulumi.StringMapInput }
The set of arguments for constructing a Vault resource.
func (VaultArgs) ElementType ¶
type VaultInput ¶ added in v3.13.0
type VaultInput interface { pulumi.Input ToVaultOutput() VaultOutput ToVaultOutputWithContext(ctx context.Context) VaultOutput }
type VaultNotifications ¶ added in v3.6.0
type VaultNotifications struct { pulumi.CustomResourceState // The ARN of the vault. BackupVaultArn pulumi.StringOutput `pulumi:"backupVaultArn"` // An array of events that indicate the status of jobs to back up resources to the backup vault. BackupVaultEvents pulumi.StringArrayOutput `pulumi:"backupVaultEvents"` // Name of the backup vault to add notifications for. BackupVaultName pulumi.StringOutput `pulumi:"backupVaultName"` // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events SnsTopicArn pulumi.StringOutput `pulumi:"snsTopicArn"` }
Provides an AWS Backup vault notifications resource.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/iam" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/sns" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { testTopic, err := sns.NewTopic(ctx, "testTopic", nil) if err != nil { return err } _, err = sns.NewTopicPolicy(ctx, "testTopicPolicy", &sns.TopicPolicyArgs{ Arn: testTopic.Arn, Policy: testPolicyDocument.ApplyT(func(testPolicyDocument iam.GetPolicyDocumentResult) (string, error) { return testPolicyDocument.Json, nil }).(pulumi.StringOutput), }) if err != nil { return err } _, err = backup.NewVaultNotifications(ctx, "testVaultNotifications", &backup.VaultNotificationsArgs{ BackupVaultName: pulumi.String("example_backup_vault"), SnsTopicArn: testTopic.Arn, BackupVaultEvents: pulumi.StringArray{ pulumi.String("BACKUP_JOB_STARTED"), pulumi.String("RESTORE_JOB_COMPLETED"), }, }) if err != nil { return err } return nil }) }
```
## Import
Backup vault notifications can be imported using the `name`, e.g.
```sh
$ pulumi import aws:backup/vaultNotifications:VaultNotifications test TestVault
```
func GetVaultNotifications ¶ added in v3.6.0
func GetVaultNotifications(ctx *pulumi.Context, name string, id pulumi.IDInput, state *VaultNotificationsState, opts ...pulumi.ResourceOption) (*VaultNotifications, error)
GetVaultNotifications gets an existing VaultNotifications resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewVaultNotifications ¶ added in v3.6.0
func NewVaultNotifications(ctx *pulumi.Context, name string, args *VaultNotificationsArgs, opts ...pulumi.ResourceOption) (*VaultNotifications, error)
NewVaultNotifications registers a new resource with the given unique name, arguments, and options.
func (VaultNotifications) ElementType ¶ added in v3.13.0
func (VaultNotifications) ElementType() reflect.Type
func (VaultNotifications) ToVaultNotificationsOutput ¶ added in v3.13.0
func (i VaultNotifications) ToVaultNotificationsOutput() VaultNotificationsOutput
func (VaultNotifications) ToVaultNotificationsOutputWithContext ¶ added in v3.13.0
func (i VaultNotifications) ToVaultNotificationsOutputWithContext(ctx context.Context) VaultNotificationsOutput
type VaultNotificationsArgs ¶ added in v3.6.0
type VaultNotificationsArgs struct { // An array of events that indicate the status of jobs to back up resources to the backup vault. BackupVaultEvents pulumi.StringArrayInput // Name of the backup vault to add notifications for. BackupVaultName pulumi.StringInput // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events SnsTopicArn pulumi.StringInput }
The set of arguments for constructing a VaultNotifications resource.
func (VaultNotificationsArgs) ElementType ¶ added in v3.6.0
func (VaultNotificationsArgs) ElementType() reflect.Type
type VaultNotificationsInput ¶ added in v3.13.0
type VaultNotificationsInput interface { pulumi.Input ToVaultNotificationsOutput() VaultNotificationsOutput ToVaultNotificationsOutputWithContext(ctx context.Context) VaultNotificationsOutput }
type VaultNotificationsOutput ¶ added in v3.13.0
type VaultNotificationsOutput struct {
*pulumi.OutputState
}
func (VaultNotificationsOutput) ElementType ¶ added in v3.13.0
func (VaultNotificationsOutput) ElementType() reflect.Type
func (VaultNotificationsOutput) ToVaultNotificationsOutput ¶ added in v3.13.0
func (o VaultNotificationsOutput) ToVaultNotificationsOutput() VaultNotificationsOutput
func (VaultNotificationsOutput) ToVaultNotificationsOutputWithContext ¶ added in v3.13.0
func (o VaultNotificationsOutput) ToVaultNotificationsOutputWithContext(ctx context.Context) VaultNotificationsOutput
type VaultNotificationsState ¶ added in v3.6.0
type VaultNotificationsState struct { // The ARN of the vault. BackupVaultArn pulumi.StringPtrInput // An array of events that indicate the status of jobs to back up resources to the backup vault. BackupVaultEvents pulumi.StringArrayInput // Name of the backup vault to add notifications for. BackupVaultName pulumi.StringPtrInput // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events SnsTopicArn pulumi.StringPtrInput }
func (VaultNotificationsState) ElementType ¶ added in v3.6.0
func (VaultNotificationsState) ElementType() reflect.Type
type VaultOutput ¶ added in v3.13.0
type VaultOutput struct {
*pulumi.OutputState
}
func (VaultOutput) ElementType ¶ added in v3.13.0
func (VaultOutput) ElementType() reflect.Type
func (VaultOutput) ToVaultOutput ¶ added in v3.13.0
func (o VaultOutput) ToVaultOutput() VaultOutput
func (VaultOutput) ToVaultOutputWithContext ¶ added in v3.13.0
func (o VaultOutput) ToVaultOutputWithContext(ctx context.Context) VaultOutput
type VaultPolicy ¶ added in v3.14.0
type VaultPolicy struct { pulumi.CustomResourceState // The ARN of the vault. BackupVaultArn pulumi.StringOutput `pulumi:"backupVaultArn"` // Name of the backup vault to add policy for. BackupVaultName pulumi.StringOutput `pulumi:"backupVaultName"` // The backup vault access policy document in JSON format. Policy pulumi.StringOutput `pulumi:"policy"` }
Provides an AWS Backup vault policy resource.
## Example Usage
```go package main
import (
"fmt" "github.com/pulumi/pulumi-aws/sdk/v3/go/aws/backup" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleVault, err := backup.NewVault(ctx, "exampleVault", nil) if err != nil { return err } _, err = backup.NewVaultPolicy(ctx, "exampleVaultPolicy", &backup.VaultPolicyArgs{ BackupVaultName: exampleVault.Name, Policy: exampleVault.Arn.ApplyT(func(arn string) (string, error) { return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", " \"Version\": \"2012-10-17\",\n", " \"Id\": \"default\",\n", " \"Statement\": [\n", " {\n", " \"Sid\": \"default\",\n", " \"Effect\": \"Allow\",\n", " \"Principal\": {\n", " \"AWS\": \"*\"\n", " },\n", " \"Action\": [\n", " \"backup:DescribeBackupVault\",\n", " \"backup:DeleteBackupVault\",\n", " \"backup:PutBackupVaultAccessPolicy\",\n", " \"backup:DeleteBackupVaultAccessPolicy\",\n", " \"backup:GetBackupVaultAccessPolicy\",\n", " \"backup:StartBackupJob\",\n", " \"backup:GetBackupVaultNotifications\",\n", " \"backup:PutBackupVaultNotifications\"\n", " ],\n", " \"Resource\": \"", arn, "\"\n", " }\n", " ]\n", "}\n"), nil }).(pulumi.StringOutput), }) if err != nil { return err } return nil }) }
```
## Import
Backup vault policy can be imported using the `name`, e.g.
```sh
$ pulumi import aws:backup/vaultPolicy:VaultPolicy test TestVault
```
func GetVaultPolicy ¶ added in v3.14.0
func GetVaultPolicy(ctx *pulumi.Context, name string, id pulumi.IDInput, state *VaultPolicyState, opts ...pulumi.ResourceOption) (*VaultPolicy, error)
GetVaultPolicy gets an existing VaultPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewVaultPolicy ¶ added in v3.14.0
func NewVaultPolicy(ctx *pulumi.Context, name string, args *VaultPolicyArgs, opts ...pulumi.ResourceOption) (*VaultPolicy, error)
NewVaultPolicy registers a new resource with the given unique name, arguments, and options.
func (VaultPolicy) ElementType ¶ added in v3.14.0
func (VaultPolicy) ElementType() reflect.Type
func (VaultPolicy) ToVaultPolicyOutput ¶ added in v3.14.0
func (i VaultPolicy) ToVaultPolicyOutput() VaultPolicyOutput
func (VaultPolicy) ToVaultPolicyOutputWithContext ¶ added in v3.14.0
func (i VaultPolicy) ToVaultPolicyOutputWithContext(ctx context.Context) VaultPolicyOutput
type VaultPolicyArgs ¶ added in v3.14.0
type VaultPolicyArgs struct { // Name of the backup vault to add policy for. BackupVaultName pulumi.StringInput // The backup vault access policy document in JSON format. Policy pulumi.StringInput }
The set of arguments for constructing a VaultPolicy resource.
func (VaultPolicyArgs) ElementType ¶ added in v3.14.0
func (VaultPolicyArgs) ElementType() reflect.Type
type VaultPolicyInput ¶ added in v3.14.0
type VaultPolicyInput interface { pulumi.Input ToVaultPolicyOutput() VaultPolicyOutput ToVaultPolicyOutputWithContext(ctx context.Context) VaultPolicyOutput }
type VaultPolicyOutput ¶ added in v3.14.0
type VaultPolicyOutput struct {
*pulumi.OutputState
}
func (VaultPolicyOutput) ElementType ¶ added in v3.14.0
func (VaultPolicyOutput) ElementType() reflect.Type
func (VaultPolicyOutput) ToVaultPolicyOutput ¶ added in v3.14.0
func (o VaultPolicyOutput) ToVaultPolicyOutput() VaultPolicyOutput
func (VaultPolicyOutput) ToVaultPolicyOutputWithContext ¶ added in v3.14.0
func (o VaultPolicyOutput) ToVaultPolicyOutputWithContext(ctx context.Context) VaultPolicyOutput
type VaultPolicyState ¶ added in v3.14.0
type VaultPolicyState struct { // The ARN of the vault. BackupVaultArn pulumi.StringPtrInput // Name of the backup vault to add policy for. BackupVaultName pulumi.StringPtrInput // The backup vault access policy document in JSON format. Policy pulumi.StringPtrInput }
func (VaultPolicyState) ElementType ¶ added in v3.14.0
func (VaultPolicyState) ElementType() reflect.Type
type VaultState ¶
type VaultState struct { // The ARN of the vault. Arn pulumi.StringPtrInput // The server-side encryption key that is used to protect your backups. KmsKeyArn pulumi.StringPtrInput // Name of the backup vault to create. Name pulumi.StringPtrInput // The number of recovery points that are stored in a backup vault. RecoveryPoints pulumi.IntPtrInput // Metadata that you can assign to help organize the resources that you create. Tags pulumi.StringMapInput }
func (VaultState) ElementType ¶
func (VaultState) ElementType() reflect.Type