redshift_cross_region_snapshots – Manage Redshift Cross Region Snapshots¶
New in version 2.8.
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¶
Notes¶
Note
- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_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
orEC2_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.