Class: Aws::SecurityHub::Types::AwsBackupBackupPlanRuleDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsBackupBackupPlanRuleDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completion_window_minutes ⇒ Integer

  A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

• #copy_actions ⇒ Array<Types::AwsBackupBackupPlanRuleCopyActionsDetails>

  An array of CopyAction objects, each of which contains details of the copy operation.

• #enable_continuous_backup ⇒ Boolean

  Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

• #lifecycle ⇒ Types::AwsBackupBackupPlanLifecycleDetails

  Defines when a protected resource is transitioned to cold storage and when it expires.

• #rule_id ⇒ String

  Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

• #rule_name ⇒ String

  A display name for a backup rule.

• #schedule_expression ⇒ String

  A cron expression in UTC specifying when Backup initiates a backup job.

• #start_window_minutes ⇒ Integer

  A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

• #target_backup_vault ⇒ String

  The name of a logical container where backups are stored.

Instance Attribute Details

#completion_window_minutes ⇒ Integer

A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#copy_actions ⇒ Array<Types::AwsBackupBackupPlanRuleCopyActionsDetails>

An array of CopyAction objects, each of which contains details of the copy operation.

Returns:

• (Array<Types::AwsBackupBackupPlanRuleCopyActionsDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#enable_continuous_backup ⇒ Boolean

Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycle ⇒ Types::AwsBackupBackupPlanLifecycleDetails

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

Returns:

• (Types::AwsBackupBackupPlanLifecycleDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#rule_name ⇒ String

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

A cron expression in UTC specifying when Backup initiates a backup job.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#start_window_minutes ⇒ Integer

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#target_backup_vault ⇒ String

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 3369

class AwsBackupBackupPlanRuleDetails < Struct.new(
  :target_backup_vault,
  :start_window_minutes,
  :schedule_expression,
  :rule_name,
  :rule_id,
  :enable_continuous_backup,
  :completion_window_minutes,
  :copy_actions,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end