cloudfront_info – Obtain facts about an AWS CloudFront distribution

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Gets information about an AWS CloudFront distribution
• This module was called cloudfront_facts before Ansible 2.9, returning ansible_facts. Note that the cloudfront_info module no longer returns ansible_facts!

Aliases: cloudfront_facts

Requirements

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

• boto
• boto3 >= 1.0.0
• python >= 2.6

Parameters

Notes

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Get a summary of distributions
- cloudfront_info:
    summary: true
  register: result

# Get information about a distribution
- cloudfront_info:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
  register: result_did
- debug:
    msg: "{{ result_did['cloudfront']['my-cloudfront-distribution-id'] }}"

# Get information about a distribution using the CNAME of the cloudfront distribution.
- cloudfront_info:
    distribution: true
    domain_name_alias: www.my-website.com
  register: result_website
- debug:
    msg: "{{ result_website['cloudfront']['www.my-website.com'] }}"

# When the module is called as cloudfront_facts, return values are published
# in ansible_facts['cloudfront'][<id>] and can be used as follows.
# Note that this is deprecated and will stop working in Ansible 2.13.
- cloudfront_facts:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
- debug:
    msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"

- cloudfront_facts:
    distribution: true
    domain_name_alias: www.my-website.com
- debug:
    msg: "{{ ansible_facts['cloudfront']['www.my-website.com'] }}"

# Get all information about an invalidation for a distribution.
- cloudfront_facts:
    invalidation: true
    distribution_id: my-cloudfront-distribution-id
    invalidation_id: my-cloudfront-invalidation-id

# Get all information about a cloudfront origin access identity.
- cloudfront_facts:
    origin_access_identity: true
    origin_access_identity_id: my-cloudfront-origin-access-identity-id

# Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
- cloudfront_facts:
    origin_access_identity: true
    origin_access_identity_id: my-cloudfront-origin-access-identity-id

# Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
- cloudfront_facts:
    all_lists: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Willem van Ketwich (@wilvk)