tiering_configurations

Creates, updates, deletes, gets or lists a tiering_configurations resource.

Overview

Name	tiering_configurations
Type	Resource
Id	aws.backup.tiering_configurations

Fields

The following fields are returned by SELECT queries:

get_tiering_configuration

Name	Datatype	Description
backup_vault_name	string	The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults. (pattern: <code>^(*|[a-zA-Z0-9-_]{2,50})$</code>)
creation_time	string (date-time)	The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
creator_request_id	string	This is a unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
last_updated_time	string (date-time)	The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
resource_selection	array	An array of resource selection objects that specify which resources are included in the tiering configuration and their tiering settings.
tiering_configuration_arn	string	An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
tiering_configuration_name	string	The unique name of the tiering configuration. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores. (pattern: <code>^[a-zA-Z0-9_]{1,200}$</code>)

list_tiering_configurations

Name	Datatype	Description
backup_vault_name	string	The name of the backup vault where the tiering configuration applies. Use * to apply to all backup vaults. (pattern: <code>^(*|[a-zA-Z0-9-_]{2,50})$</code>)
creation_time	string (date-time)	The date and time a tiering configuration was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
last_updated_time	string (date-time)	The date and time a tiering configuration was updated, in Unix format and Coordinated Universal Time (UTC). The value of LastUpdatedTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
tiering_configuration_arn	string	An Amazon Resource Name (ARN) that uniquely identifies the tiering configuration.
tiering_configuration_name	string	The unique name of the tiering configuration. (pattern: <code>^[a-zA-Z0-9_]{1,200}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tiering_configuration	select	tiering_configuration_name, region		Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.
list_tiering_configurations	select	region	maxResults, nextToken	Returns a list of tiering configurations.
create_tiering_configuration	insert	region, TieringConfiguration		Creates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.
update_tiering_configuration	update	tiering_configuration_name, region, TieringConfiguration		This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceType
delete_tiering_configuration	delete	tiering_configuration_name, region		Deletes the tiering configuration specified by a tiering configuration name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
tiering_configuration_name	string	The unique name of a tiering configuration.
maxResults	integer	The maximum number of items to be returned.
nextToken	string	The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

SELECT examples

get_tiering_configuration

Returns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.

SELECT
backup_vault_name,
creation_time,
creator_request_id,
last_updated_time,
resource_selection,
tiering_configuration_arn,
tiering_configuration_name
FROM aws.backup.tiering_configurations
WHERE tiering_configuration_name = '{{ tiering_configuration_name }}' -- required
AND region = '{{ region }}' -- required
;

list_tiering_configurations

Returns a list of tiering configurations.

SELECT
backup_vault_name,
creation_time,
last_updated_time,
tiering_configuration_arn,
tiering_configuration_name
FROM aws.backup.tiering_configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_tiering_configuration

Creates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.

INSERT INTO aws.backup.tiering_configurations (
TieringConfiguration,
TieringConfigurationTags,
CreatorRequestId,
region
)
SELECT 
'{{ TieringConfiguration }}' /* required */,
'{{ TieringConfigurationTags }}',
'{{ CreatorRequestId }}',
'{{ region }}'
RETURNING
creation_time,
tiering_configuration_arn,
tiering_configuration_name
;

Manifest

# Description fields are for documentation purposes
- name: tiering_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tiering_configurations resource.
  - name: TieringConfiguration
    description: |
      This contains metadata about a tiering configuration for create operations.
    value:
      TieringConfigurationName: "{{ TieringConfigurationName }}"
      BackupVaultName: "{{ BackupVaultName }}"
      ResourceSelection:
        - Resources: "{{ Resources }}"
          TieringDownSettingsInDays: {{ TieringDownSettingsInDays }}
          ResourceType: "{{ ResourceType }}"
  - name: TieringConfigurationTags
    value: "{{ TieringConfigurationTags }}"
  - name: CreatorRequestId
    value: "{{ CreatorRequestId }}"

UPDATE examples

update_tiering_configuration

This request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceType

UPDATE aws.backup.tiering_configurations
SET 
TieringConfiguration = '{{ TieringConfiguration }}'
WHERE 
tiering_configuration_name = '{{ tiering_configuration_name }}' --required
AND region = '{{ region }}' --required
AND TieringConfiguration = '{{ TieringConfiguration }}' --required
RETURNING
creation_time,
last_updated_time,
tiering_configuration_arn,
tiering_configuration_name;

DELETE examples

delete_tiering_configuration

Deletes the tiering configuration specified by a tiering configuration name.

DELETE FROM aws.backup.tiering_configurations
WHERE tiering_configuration_name = '{{ tiering_configuration_name }}' --required
AND region = '{{ region }}' --required
;