AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass BackupPlanInput data as a 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
        },
      ],
      enable_continuous_backup: false,
    },
  ],
  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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_backup_settingsArray<Types::AdvancedBackupSetting>

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

Returns:



345
346
347
348
349
350
351
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 345

class BackupPlanInput < Struct.new(
  :backup_plan_name,
  :rules,
  :advanced_backup_settings)
  SENSITIVE = []
  include Aws::Structure
end

#backup_plan_nameString

The optional display name of a backup plan.

Returns:

  • (String)


345
346
347
348
349
350
351
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 345

class BackupPlanInput < Struct.new(
  :backup_plan_name,
  :rules,
  :advanced_backup_settings)
  SENSITIVE = []
  include Aws::Structure
end

#rulesArray<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:



345
346
347
348
349
350
351
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 345

class BackupPlanInput < Struct.new(
  :backup_plan_name,
  :rules,
  :advanced_backup_settings)
  SENSITIVE = []
  include Aws::Structure
end