backup_selections

Creates, updates, deletes or gets a backup_selection resource or lists backup_selections in a region

Overview

Name	backup_selections
Type	Resource
Description	Resource Type definition for AWS::Backup::BackupSelection
Id	awscc.backup.backup_selections

Fields

get (all properties)

Name	Datatype	Description
id	string
backup_plan_id	string
▶backup_selection	object
selection_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::Backup::BackupSelection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	backup_selections	INSERT	BackupSelection, BackupPlanId, region
delete_resource	backup_selections	DELETE	Identifier, region
list_resources	backup_selections_list_only	SELECT	region
get_resource	backup_selections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual backup_selection.

SELECT
  region,
  id,
  backup_plan_id,
  backup_selection,
  selection_id
FROM awscc.backup.backup_selections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all backup_selections in a region.

SELECT
  region,
  id
FROM awscc.backup.backup_selections_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new backup_selection resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.backup.backup_selections (
  BackupPlanId,
  BackupSelection,
  region
)
SELECT
  '{{ backup_plan_id }}',
  '{{ backup_selection }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.backup.backup_selections (
  BackupPlanId,
  BackupSelection,
  region
)
SELECT
  '{{ backup_plan_id }}',
  '{{ backup_selection }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: backup_selection
  props:
    - name: backup_plan_id
      value: '{{ backup_plan_id }}'
    - name: backup_selection
      value:
        iam_role_arn: '{{ iam_role_arn }}'
        list_of_tags:
          - condition_key: '{{ condition_key }}'
            condition_value: '{{ condition_value }}'
            condition_type: '{{ condition_type }}'
        resources:
          - '{{ resources[0] }}'
        selection_name: '{{ selection_name }}'
        not_resources:
          - '{{ not_resources[0] }}'
        conditions:
          string_equals:
            - condition_key: '{{ condition_key }}'
              condition_value: '{{ condition_value }}'
          string_not_equals:
            - null
          string_like:
            - null
          string_not_like:
            - null

DELETE example

/*+ delete */
DELETE FROM awscc.backup.backup_selections
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the backup_selections resource, the following permissions are required:

Delete

backup:GetBackupSelection,
backup:DeleteBackupSelection

Read

backup:GetBackupSelection

Create

backup:CreateBackupSelection,
iam:GetRole,
iam:PassRole,
iam:CreateServiceLinkedRole

List

backup:ListBackupSelections,
backup:ListBackupPlans