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

Class: Aws::Backup::Types::CreateBackupPlanInput

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 CreateBackupPlanInput data as a hash:

{
  backup_plan: { # required
    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",
        },
      },
    ],
  },
  backup_plan_tags: {
    "TagKey" => "TagValue",
  },
  creator_request_id: "string",
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_planTypes::BackupPlanInput

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.



721
722
723
724
725
726
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 721

class CreateBackupPlanInput < Struct.new(
  :backup_plan,
  :backup_plan_tags,
  :creator_request_id)
  include Aws::Structure
end

#backup_plan_tagsHash<String,String>

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Returns:

  • (Hash<String,String>)


721
722
723
724
725
726
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 721

class CreateBackupPlanInput < Struct.new(
  :backup_plan,
  :backup_plan_tags,
  :creator_request_id)
  include Aws::Structure
end

#creator_request_idString

Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Returns:

  • (String)


721
722
723
724
725
726
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 721

class CreateBackupPlanInput < Struct.new(
  :backup_plan,
  :backup_plan_tags,
  :creator_request_id)
  include Aws::Structure
end