/AWS1/CL_BUPBACKUPRULEINPUT

Specifies a scheduled task used to back up a selection of resources.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_rulename TYPE /AWS1/BUPBACKUPRULENAME /AWS1/BUPBACKUPRULENAME

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

iv_targetbackupvaultname TYPE /AWS1/BUPBACKUPVAULTNAME /AWS1/BUPBACKUPVAULTNAME

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

Optional arguments:

iv_scheduleexpression TYPE /AWS1/BUPCRONEXPRESSION /AWS1/BUPCRONEXPRESSION

A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

iv_startwindowminutes TYPE /AWS1/BUPWINDOWMINUTES /AWS1/BUPWINDOWMINUTES

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

iv_completionwindowminutes TYPE /AWS1/BUPWINDOWMINUTES /AWS1/BUPWINDOWMINUTES

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

io_lifecycle TYPE REF TO /AWS1/CL_BUPLIFECYCLE /AWS1/CL_BUPLIFECYCLE

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold storage.

Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

This parameter has a maximum value of 100 years (36,500 days).

it_recoverypointtags TYPE /AWS1/CL_BUPTAGS_W=>TT_TAGS TT_TAGS

The tags to assign to the resources.

it_copyactions TYPE /AWS1/CL_BUPCOPYACTION=>TT_COPYACTIONS TT_COPYACTIONS

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

iv_enablecontinuousbackup TYPE /AWS1/BUPBOOLEAN /AWS1/BUPBOOLEAN

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

iv_schedulexprsntimezone TYPE /AWS1/BUPTIMEZONE /AWS1/BUPTIMEZONE

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

it_indexactions TYPE /AWS1/CL_BUPINDEXACTION=>TT_INDEXACTIONS TT_INDEXACTIONS

There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

• EBS for Amazon Elastic Block Store

• S3 for Amazon Simple Storage Service (Amazon S3)

---

Queryable Attributes

RuleName

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

Accessible with the following methods

Method	Description
GET_RULENAME()	Getter for RULENAME, with configurable default
ASK_RULENAME()	Getter for RULENAME w/ exceptions if field has no value
HAS_RULENAME()	Determine if RULENAME has a value

TargetBackupVaultName

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

Accessible with the following methods

Method	Description
GET_TARGETBACKUPVAULTNAME()	Getter for TARGETBACKUPVAULTNAME, with configurable default
ASK_TARGETBACKUPVAULTNAME()	Getter for TARGETBACKUPVAULTNAME w/ exceptions if field has
HAS_TARGETBACKUPVAULTNAME()	Determine if TARGETBACKUPVAULTNAME has a value

ScheduleExpression

A CRON expression in UTC specifying when Backup initiates a backup job. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

Accessible with the following methods

Method	Description
GET_SCHEDULEEXPRESSION()	Getter for SCHEDULEEXPRESSION, with configurable default
ASK_SCHEDULEEXPRESSION()	Getter for SCHEDULEEXPRESSION w/ exceptions if field has no
HAS_SCHEDULEEXPRESSION()	Determine if SCHEDULEEXPRESSION has a value

StartWindowMinutes

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.

This parameter has a maximum value of 100 years (52,560,000 minutes).

During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

Accessible with the following methods

Method	Description
GET_STARTWINDOWMINUTES()	Getter for STARTWINDOWMINUTES, with configurable default
ASK_STARTWINDOWMINUTES()	Getter for STARTWINDOWMINUTES w/ exceptions if field has no
HAS_STARTWINDOWMINUTES()	Determine if STARTWINDOWMINUTES has a value

CompletionWindowMinutes

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

Accessible with the following methods

Method	Description
GET_COMPLETIONWINDOWMINUTES()	Getter for COMPLETIONWINDOWMINUTES, with configurable defaul
ASK_COMPLETIONWINDOWMINUTES()	Getter for COMPLETIONWINDOWMINUTES w/ exceptions if field ha
HAS_COMPLETIONWINDOWMINUTES()	Determine if COMPLETIONWINDOWMINUTES has a value

Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold storage.

Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

This parameter has a maximum value of 100 years (36,500 days).

Accessible with the following methods

Method	Description
GET_LIFECYCLE()	Getter for LIFECYCLE

RecoveryPointTags

The tags to assign to the resources.

Accessible with the following methods

Method	Description
GET_RECOVERYPOINTTAGS()	Getter for RECOVERYPOINTTAGS, with configurable default
ASK_RECOVERYPOINTTAGS()	Getter for RECOVERYPOINTTAGS w/ exceptions if field has no v
HAS_RECOVERYPOINTTAGS()	Determine if RECOVERYPOINTTAGS has a value

CopyActions

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

Accessible with the following methods

Method	Description
GET_COPYACTIONS()	Getter for COPYACTIONS, with configurable default
ASK_COPYACTIONS()	Getter for COPYACTIONS w/ exceptions if field has no value
HAS_COPYACTIONS()	Determine if COPYACTIONS has a value

EnableContinuousBackup

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

Accessible with the following methods

Method	Description
GET_ENABLECONTINUOUSBACKUP()	Getter for ENABLECONTINUOUSBACKUP, with configurable default
ASK_ENABLECONTINUOUSBACKUP()	Getter for ENABLECONTINUOUSBACKUP w/ exceptions if field has
HAS_ENABLECONTINUOUSBACKUP()	Determine if ENABLECONTINUOUSBACKUP has a value

ScheduleExpressionTimezone

The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

Accessible with the following methods

Method	Description
GET_SCHEDULEXPRSNTIMEZONE()	Getter for SCHEDULEEXPRESSIONTIMEZONE, with configurable def
ASK_SCHEDULEXPRSNTIMEZONE()	Getter for SCHEDULEEXPRESSIONTIMEZONE w/ exceptions if field
HAS_SCHEDULEXPRSNTIMEZONE()	Determine if SCHEDULEEXPRESSIONTIMEZONE has a value

IndexActions

There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

• EBS for Amazon Elastic Block Store

• S3 for Amazon Simple Storage Service (Amazon S3)

Accessible with the following methods

Method	Description
GET_INDEXACTIONS()	Getter for INDEXACTIONS, with configurable default
ASK_INDEXACTIONS()	Getter for INDEXACTIONS w/ exceptions if field has no value
HAS_INDEXACTIONS()	Determine if INDEXACTIONS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_BACKUPRULESINPUT

TYPES TT_BACKUPRULESINPUT TYPE STANDARD TABLE OF REF TO /AWS1/CL_BUPBACKUPRULEINPUT WITH DEFAULT KEY
.