Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Backup::Types::BackupPlanInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BackupPlanInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  backup_plan_name: "BackupPlanName", # required
  rules: [ # required
    {
      rule_name: "BackupRuleName", # required
      target_backup_vault_name: "BackupVaultName", # required
      schedule_expression: "CronExpression",
      start_window_minutes: 1,
      completion_window_minutes: 1,
      lifecycle: {
        move_to_cold_storage_after_days: 1,
        delete_after_days: 1,
      },
      recovery_point_tags: {
        "TagKey" => "TagValue",
      },
      copy_actions: [
        {
          lifecycle: {
            move_to_cold_storage_after_days: 1,
            delete_after_days: 1,
          },
          destination_backup_vault_arn: "ARN", # required
        },
      ],
    },
  ],
  advanced_backup_settings: [
    {
      resource_type: "ResourceType",
      backup_options: {
        "BackupOptionKey" => "BackupOptionValue",
      },
    },
  ],
}

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_backup_settings ⇒ Array<Types::AdvancedBackupSetting>

Specifies a list of BackupOptions for each resource type. These settings are only available for Windows VSS backup jobs.

Returns:

#backup_plan_name ⇒ String

The optional display name of a backup plan.

Returns:

  • (String) —

    The optional display name of a backup plan.

#rules ⇒ Array<Types::BackupRuleInput>

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

Returns:

  • (Array<Types::BackupRuleInput>) —

    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.