backup

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.backup.Plan(resource_name, opts=None, name=None, rules=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an AWS Backup plan resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The display name of a backup plan.

  • rules (pulumi.Input[list]) – A rule object that specifies a scheduled task that is used to back up a selection of resources.

  • tags (pulumi.Input[dict]) – Metadata that you can assign to help organize the plans you create.

The rules object supports the following:

  • completionWindow (pulumi.Input[float]) - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

  • lifecycle (pulumi.Input[dict]) - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Fields documented below.

    • coldStorageAfter (pulumi.Input[float]) - Specifies the number of days after creation that a recovery point is moved to cold storage.

    • deleteAfter (pulumi.Input[float]) - Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_after.

  • recoveryPointTags (pulumi.Input[dict]) - Metadata that you can assign to help organize the resources that you create.

  • ruleName (pulumi.Input[str]) - An display name for a backup rule.

  • schedule (pulumi.Input[str]) - A CRON expression specifying when AWS Backup initiates a backup job.

  • startWindow (pulumi.Input[float]) - The amount of time in minutes before beginning a backup.

  • targetVaultName (pulumi.Input[str]) - The name of a logical container where backups are stored.

arn = None

The ARN of the backup plan.

name = None

The display name of a backup plan.

rules = None

A rule object that specifies a scheduled task that is used to back up a selection of resources.

  • completionWindow (float) - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

  • lifecycle (dict) - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Fields documented below.

    • coldStorageAfter (float) - Specifies the number of days after creation that a recovery point is moved to cold storage.

    • deleteAfter (float) - Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_after.

  • recoveryPointTags (dict) - Metadata that you can assign to help organize the resources that you create.

  • ruleName (str) - An display name for a backup rule.

  • schedule (str) - A CRON expression specifying when AWS Backup initiates a backup job.

  • startWindow (float) - The amount of time in minutes before beginning a backup.

  • targetVaultName (str) - The name of a logical container where backups are stored.

tags = None

Metadata that you can assign to help organize the plans you create.

version = None

Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

static get(resource_name, id, opts=None, arn=None, name=None, rules=None, tags=None, version=None)

Get an existing Plan resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the backup plan.

  • name (pulumi.Input[str]) – The display name of a backup plan.

  • rules (pulumi.Input[list]) – A rule object that specifies a scheduled task that is used to back up a selection of resources.

  • tags (pulumi.Input[dict]) – Metadata that you can assign to help organize the plans you create.

  • version (pulumi.Input[str]) – Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

The rules object supports the following:

  • completionWindow (pulumi.Input[float]) - The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

  • lifecycle (pulumi.Input[dict]) - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Fields documented below.

    • coldStorageAfter (pulumi.Input[float]) - Specifies the number of days after creation that a recovery point is moved to cold storage.

    • deleteAfter (pulumi.Input[float]) - Specifies the number of days after creation that a recovery point is deleted. Must be 90 days greater than cold_storage_after.

  • recoveryPointTags (pulumi.Input[dict]) - Metadata that you can assign to help organize the resources that you create.

  • ruleName (pulumi.Input[str]) - An display name for a backup rule.

  • schedule (pulumi.Input[str]) - A CRON expression specifying when AWS Backup initiates a backup job.

  • startWindow (pulumi.Input[float]) - The amount of time in minutes before beginning a backup.

  • targetVaultName (pulumi.Input[str]) - The name of a logical container where backups are stored.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.backup.Selection(resource_name, opts=None, iam_role_arn=None, name=None, plan_id=None, resources=None, selection_tags=None, __props__=None, __name__=None, __opts__=None)

Manages selection conditions for AWS Backup plan resources.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • iam_role_arn (pulumi.Input[str]) – 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 for additional information about using AWS managed policies or creating custom policies attached to the IAM role.

  • name (pulumi.Input[str]) – The display name of a resource selection document.

  • plan_id (pulumi.Input[str]) – The backup plan ID to be associated with the selection of resources.

  • resources (pulumi.Input[list]) – An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan..

  • selection_tags (pulumi.Input[list]) – Tag-based conditions used to specify a set of resources to assign to a backup plan.

The selection_tags object supports the following:

  • key (pulumi.Input[str]) - The key in a key-value pair.

  • type (pulumi.Input[str]) - An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

  • value (pulumi.Input[str]) - The value in a key-value pair.

iam_role_arn = None

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 for additional information about using AWS managed policies or creating custom policies attached to the IAM role.

name = None

The display name of a resource selection document.

plan_id = None

The backup plan ID to be associated with the selection of resources.

resources = None

An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan..

selection_tags = None

Tag-based conditions used to specify a set of resources to assign to a backup plan.

  • key (str) - The key in a key-value pair.

  • type (str) - An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

  • value (str) - The value in a key-value pair.

static get(resource_name, id, opts=None, iam_role_arn=None, name=None, plan_id=None, resources=None, selection_tags=None)

Get an existing Selection resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • iam_role_arn (pulumi.Input[str]) –

    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 for additional information about using AWS managed policies or creating custom policies attached to the IAM role.

  • name (pulumi.Input[str]) – The display name of a resource selection document.

  • plan_id (pulumi.Input[str]) – The backup plan ID to be associated with the selection of resources.

  • resources (pulumi.Input[list]) – An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan..

  • selection_tags (pulumi.Input[list]) – Tag-based conditions used to specify a set of resources to assign to a backup plan.

The selection_tags object supports the following:

  • key (pulumi.Input[str]) - The key in a key-value pair.

  • type (pulumi.Input[str]) - An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

  • value (pulumi.Input[str]) - The value in a key-value pair.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.backup.Vault(resource_name, opts=None, kms_key_arn=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides an AWS Backup vault resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • kms_key_arn (pulumi.Input[str]) – The server-side encryption key that is used to protect your backups.

  • name (pulumi.Input[str]) – Name of the backup vault to create.

  • tags (pulumi.Input[dict]) – Metadata that you can assign to help organize the resources that you create.

arn = None

The ARN of the vault.

kms_key_arn = None

The server-side encryption key that is used to protect your backups.

name = None

Name of the backup vault to create.

recovery_points = None

The number of recovery points that are stored in a backup vault.

tags = None

Metadata that you can assign to help organize the resources that you create.

static get(resource_name, id, opts=None, arn=None, kms_key_arn=None, name=None, recovery_points=None, tags=None)

Get an existing Vault resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the vault.

  • kms_key_arn (pulumi.Input[str]) – The server-side encryption key that is used to protect your backups.

  • name (pulumi.Input[str]) – Name of the backup vault to create.

  • recovery_points (pulumi.Input[float]) – The number of recovery points that are stored in a backup vault.

  • tags (pulumi.Input[dict]) – Metadata that you can assign to help organize the resources that you create.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str