redshift_cross_region_snapshots – Manage Redshift Cross Region Snapshots — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# redshift_cross_region_snapshots – Manage Redshift Cross Region Snapshots

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Status

## Synopsis

- Manage Redshift Cross Region Snapshots. Supports KMS-Encrypted Snapshots.

- For more information, see https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#cross-region-snapshot-copy

## Requirements

The below requirements are needed on the host that executes this module.

- boto

- boto3

- botocore

- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
cluster_name - / required |  | The name of the cluster to configure cross-region snapshots for. aliases: cluster
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
destination_region - / required |  | The region to copy snapshots to aliases: destination
ec2_url string |  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region string / required |  | The clusters region aliases: source
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
snapshot_copy_grant - |  | A grant for Amazon Redshift to use a master key in the destination region. See http://boto3.readthedocs.io/en/latest/reference/services/redshift.html#Redshift.Client.create_snapshot_copy_grant aliases: copy_grant
snapshot_retention_period - / required |  | Keep cross-region snapshots for N number of days aliases: retention_period
state - / required | Choices: present ← absent | Create or remove the cross-region snapshot configuration.
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`

- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

    - name: configure cross-region snapshot on cluster `johniscool`
      redshift_cross_region_snapshots:
        cluster_name: johniscool
        state: present
        region: us-east-1
        destination_region: us-west-2
        retention_period: 1

    - name: configure cross-region snapshot on kms-encrypted cluster
      redshift_cross_region_snapshots:
        cluster_name: whatever
        state: present
        source: us-east-1
        destination: us-west-2
        copy_grant: 'my-grant-in-destination'
        retention_period: 10

    - name: disable cross-region snapshots, necessary before most cluster modifications (rename, resize)
      redshift_cross_region_snapshots:
        cluster_name: whatever
        state: absent
        region: us-east-1
        destination_region: us-west-2

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- JR Kerkstra (@captainkerk)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.