backup

package
v2.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 23, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupPlanArgs added in v2.3.0 

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 added in v2.3.0 

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 added in v2.3.0 

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/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := backup.LookupPlan(ctx, &backup.LookupPlanArgs{
			PlanId: "tf_example_backup_plan_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupSelectionArgs added in v2.3.0 

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 added in v2.3.0 

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 added in v2.3.0 

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/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, 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 added in v2.3.0 

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 added in v2.3.0 

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 added in v2.3.0 

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/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, 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

	// 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/v2/go/aws/backup"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := backup.NewPlan(ctx, "example", &backup.PlanArgs{
			Rules: backup.PlanRuleArray{
				&backup.PlanRuleArgs{
					RuleName:        pulumi.String("tf_example_backup_rule"),
					Schedule:        pulumi.String("cron(0 12 * * ? *)"),
					TargetVaultName: pulumi.String(aws_backup_vault.Test.Name),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

type PlanArgs 

type PlanArgs struct {
	// 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 

func (PlanArgs) ElementType() reflect.Type

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 added in v2.1.0 

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 added in v2.1.0 

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 added in v2.1.0 

func (PlanRuleCopyActionArgs) ElementType() reflect.Type

func (PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutput added in v2.1.0 

func (i PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput

func (PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutputWithContext added in v2.1.0 

func (i PlanRuleCopyActionArgs) ToPlanRuleCopyActionOutputWithContext(ctx context.Context) PlanRuleCopyActionOutput

type PlanRuleCopyActionArray added in v2.1.0 

type PlanRuleCopyActionArray []PlanRuleCopyActionInput

func (PlanRuleCopyActionArray) ElementType added in v2.1.0 

func (PlanRuleCopyActionArray) ElementType() reflect.Type

func (PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutput added in v2.1.0 

func (i PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput

func (PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutputWithContext added in v2.1.0 

func (i PlanRuleCopyActionArray) ToPlanRuleCopyActionArrayOutputWithContext(ctx context.Context) PlanRuleCopyActionArrayOutput

type PlanRuleCopyActionArrayInput added in v2.1.0 

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 added in v2.1.0 

type PlanRuleCopyActionArrayOutput struct{ *pulumi.OutputState }

func (PlanRuleCopyActionArrayOutput) ElementType added in v2.1.0 

func (PlanRuleCopyActionArrayOutput) ElementType() reflect.Type

func (PlanRuleCopyActionArrayOutput) Index added in v2.1.0 

func (o PlanRuleCopyActionArrayOutput) Index(i pulumi.IntInput) PlanRuleCopyActionOutput

func (PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutput added in v2.1.0 

func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutput() PlanRuleCopyActionArrayOutput

func (PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutputWithContext added in v2.1.0 

func (o PlanRuleCopyActionArrayOutput) ToPlanRuleCopyActionArrayOutputWithContext(ctx context.Context) PlanRuleCopyActionArrayOutput

type PlanRuleCopyActionInput added in v2.1.0 

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 added in v2.1.0 

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 added in v2.1.0 

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 added in v2.1.0 

func (PlanRuleCopyActionLifecycleArgs) ElementType() reflect.Type

func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutput added in v2.1.0 

func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput

func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutputWithContext added in v2.1.0 

func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput

func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutput added in v2.1.0 

func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput

func (PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutputWithContext added in v2.1.0 

func (i PlanRuleCopyActionLifecycleArgs) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput

type PlanRuleCopyActionLifecycleInput added in v2.1.0 

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 added in v2.1.0 

type PlanRuleCopyActionLifecycleOutput struct{ *pulumi.OutputState }

func (PlanRuleCopyActionLifecycleOutput) ColdStorageAfter added in v2.1.0 

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 added in v2.1.0 

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 added in v2.1.0 

func (PlanRuleCopyActionLifecycleOutput) ElementType() reflect.Type

func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutput added in v2.1.0 

func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutput() PlanRuleCopyActionLifecycleOutput

func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutputWithContext added in v2.1.0 

func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecycleOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecycleOutput

func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutput added in v2.1.0 

func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput

func (PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext added in v2.1.0 

func (o PlanRuleCopyActionLifecycleOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput

type PlanRuleCopyActionLifecyclePtrInput added in v2.1.0 

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 added in v2.1.0 

func PlanRuleCopyActionLifecyclePtr(v *PlanRuleCopyActionLifecycleArgs) PlanRuleCopyActionLifecyclePtrInput

type PlanRuleCopyActionLifecyclePtrOutput added in v2.1.0 

type PlanRuleCopyActionLifecyclePtrOutput struct{ *pulumi.OutputState }

func (PlanRuleCopyActionLifecyclePtrOutput) ColdStorageAfter added in v2.1.0 

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 added in v2.1.0 

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) Elem added in v2.1.0 

func (o PlanRuleCopyActionLifecyclePtrOutput) Elem() PlanRuleCopyActionLifecycleOutput

func (PlanRuleCopyActionLifecyclePtrOutput) ElementType added in v2.1.0 

func (PlanRuleCopyActionLifecyclePtrOutput) ElementType() reflect.Type

func (PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutput added in v2.1.0 

func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutput() PlanRuleCopyActionLifecyclePtrOutput

func (PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext added in v2.1.0 

func (o PlanRuleCopyActionLifecyclePtrOutput) ToPlanRuleCopyActionLifecyclePtrOutputWithContext(ctx context.Context) PlanRuleCopyActionLifecyclePtrOutput

type PlanRuleCopyActionOutput added in v2.1.0 

type PlanRuleCopyActionOutput struct{ *pulumi.OutputState }

func (PlanRuleCopyActionOutput) DestinationVaultArn added in v2.1.0 

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 added in v2.1.0 

func (PlanRuleCopyActionOutput) ElementType() reflect.Type

func (PlanRuleCopyActionOutput) Lifecycle added in v2.1.0 

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 added in v2.1.0 

func (o PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutput() PlanRuleCopyActionOutput

func (PlanRuleCopyActionOutput) ToPlanRuleCopyActionOutputWithContext added in v2.1.0 

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 added in v2.1.0 

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 {
	// 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 

func (PlanState) ElementType() reflect.Type

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

### Selecting Backups By Tag

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/backup"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := backup.NewSelection(ctx, "example", &backup.SelectionArgs{
			IamRoleArn: pulumi.String(aws_iam_role.Example.Arn),
			PlanId:     pulumi.String(aws_backup_plan.Example.Id),
			SelectionTags: backup.SelectionSelectionTagArray{
				&backup.SelectionSelectionTagArgs{
					Key:   pulumi.String("foo"),
					Type:  pulumi.String("STRINGEQUALS"),
					Value: pulumi.String("bar"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

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 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/v2/go/aws/backup"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := backup.NewVault(ctx, "example", &backup.VaultArgs{
			KmsKeyArn: pulumi.String(aws_kms_key.Example.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

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 

func (VaultArgs) 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.