Skip to content
AWS for Query.Farm

aws.backup.get_backup_plan

Example SQL Queries

SELECT * FROM
aws.backup.get_backup_plan
WHERE
"backup_plan_id" = 'VALUE';

Description

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Table Definition

Column NameColumn Data Type
backup_plan_id Required Input Column

Uniquely identifies a backup plan.

VARCHAR
version_id Input Column

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
advanced_backup_settings

Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

STRUCT(
    "resource_type" VARCHAR,
    "backup_options" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
advanced_backup_settings[]
Show child fields
advanced_backup_settings[].backup_options

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

advanced_backup_settings[].resource_type

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

backup_plan

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

STRUCT(
    "backup_plan_name" VARCHAR,
    "rules" STRUCT(
        "rule_name" VARCHAR,
        "target_backup_vault_name" VARCHAR,
        "schedule_expression" VARCHAR,
        "start_window_minutes" BIGINT,
        "completion_window_minutes" BIGINT,
        "lifecycle" STRUCT(
            "move_to_cold_storage_after_days" BIGINT,
            "delete_after_days" BIGINT,
            "opt_in_to_archive_for_supported_resources" BOOLEAN
        ),
        "recovery_point_tags" MAP(VARCHAR, VARCHAR),
        "rule_id" VARCHAR,
        "copy_actions" STRUCT(
            "lifecycle" STRUCT(
                "move_to_cold_storage_after_days" BIGINT,
                "delete_after_days" BIGINT,
                "opt_in_to_archive_for_supported_resources" BOOLEAN
            ),
            "destination_backup_vault_arn" VARCHAR
        )[],
        "enable_continuous_backup" BOOLEAN,
        "schedule_expression_timezone" VARCHAR
    )[],
    "advanced_backup_settings" STRUCT(
        "resource_type" VARCHAR,
        "backup_options" MAP(VARCHAR, VARCHAR)
    )[]
)
Show child fields
backup_plan.advanced_backup_settings[]
Show child fields
backup_plan.advanced_backup_settings[].backup_options

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values:

Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

backup_plan.advanced_backup_settings[].resource_type

Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

Valid values: EC2.

backup_plan.backup_plan_name

The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

backup_plan.rules[]
Show child fields
backup_plan.rules[].completion_window_minutes

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.

backup_plan.rules[].copy_actions[]
Show child fields
backup_plan.rules[].copy_actions[].destination_backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

backup_plan.rules[].copy_actions[].lifecycle

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

Show child fields
backup_plan.rules[].copy_actions[].lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

backup_plan.rules[].copy_actions[].lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

backup_plan.rules[].copy_actions[].lifecycle.opt_in_to_archive_for_supported_resources

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

backup_plan.rules[].enable_continuous_backup

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.

backup_plan.rules[].lifecycle

The lifecycle 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.

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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

Show child fields
backup_plan.rules[].lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

backup_plan.rules[].lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

backup_plan.rules[].lifecycle.opt_in_to_archive_for_supported_resources

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

backup_plan.rules[].recovery_point_tags

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

backup_plan.rules[].rule_id

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

backup_plan.rules[].rule_name

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

backup_plan.rules[].schedule_expression

A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

backup_plan.rules[].schedule_expression_timezone

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

backup_plan.rules[].start_window_minutes

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.

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).

backup_plan.rules[].target_backup_vault_name

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. They consist of lowercase letters, numbers, and hyphens.

backup_plan_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

VARCHAR
creation_date

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

TIMESTAMP_S
creator_request_id

A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. 

VARCHAR
deletion_date

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

TIMESTAMP_S
last_execution_date

The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

TIMESTAMP_S