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

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",
      },
    },
  ],
}

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backup_plan_name ⇒ String

The display name of a backup plan.

Returns:

  • (String) 


229
230
231
232
233
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 229

class BackupPlanInput < Struct.new(
  :backup_plan_name,
  :rules)
  include Aws::Structure
end

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



229
230
231
232
233
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 229

class BackupPlanInput < Struct.new(
  :backup_plan_name,
  :rules)
  include Aws::Structure
end