Documentation

cloudfront_facts - Obtain facts about an AWS CloudFront distribution

New in version 2.3.

Synopsis

  • Gets information about an AWS CloudFront distribution

Requirements

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

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

Parameters

Parameter Choices/Defaults Comments
all_lists Default:
no
Get all cloudfront lists that do not require parameters.
aws_access_key
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
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
distribution Default:
no
Get information about a distribution. Requires distribution_id or domain_name_alias to be specified.
distribution_config Default:
no
Get the configuration information about a distribution. Requires distribution_id or domain_name_alias to be specified.
distribution_id
The id of the CloudFront distribution. Used with distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.
domain_name_alias
Can be used instead of distribution_id - uses the aliased CNAME for the cloudfront distribution to get the distribution id where required.
ec2_url
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.
invalidation Default:
no
Get information about an invalidation. Requires invalidation_id to be specified.
invalidation_id
The id of the invalidation to get information about. Used with invalidation.
list_distributions Default:
no
Get a list of cloudfront distributions.
list_distributions_by_web_acl_id Default:
no
Get a list of distributions using web acl id as a filter. Requires web_acl_id to be set.
list_invalidations Default:
no
Get a list of invalidations. Requires distribution_id or domain_name_alias to be specified.
list_origin_access_identities Default:
no
Get a list of cloudfront origin access identities. Requires origin_access_identity_id to be set.
list_streaming_distributions Default:
no
Get a list of streaming distributions.
origin_access_identity Default:
no
Get information about an origin access identity. Requires origin_access_identity_id to be specified.
origin_access_identity_config Default:
no
Get the configuration information about an origin access identity. Requires origin_access_identity_id to be specified.
origin_access_identity_id
The id of the cloudfront origin access identity to get information about.
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
region
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_token
(added in 1.6)
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
streaming_distribution Default:
no
Get information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified.
streaming_distribution_config Default:
no
Get the configuration information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified.
summary Default:
no
Returns a summary of all distributions, streaming distributions and origin_access_identities. This is the default behaviour if no option is selected.
validate_certs
bool

(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
web_acl_id
Used with list_distributions_by_web_acl_id.

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

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

# Get a summary of distributions
- cloudfront_facts:
    summary: true

# Get information about a distribution
- cloudfront_facts:
    distribution: true
    distribution_id: my-cloudfront-distribution-id

# Get information about a distribution using the CNAME of the cloudfront distribution.
- cloudfront_facts:
    distribution: true
    domain_name_alias: www.my-website.com

# Facts are published in ansible_facts['cloudfront'][<distribution_name>]
- debug:
    msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"

- 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:

Key Returned Description
distribution
dict
only if distribution is true
Facts about a cloudfront distribution. Requires distribution_id or domain_name_alias to be specified. Requires origin_access_identity_id to be set.

distribution_config
dict
only if distribution_config is true
Facts about a cloudfront distribution's config. Requires distribution_id or domain_name_alias to be specified.

invalidation
dict
only if invalidation is true
Describes the invalidation information for the distribution. Requires invalidation_id to be specified and either distribution_id or domain_name_alias.

origin_access_identity
dict
only if origin_access_identity is true
Describes the origin access identity information. Requires origin_access_identity_id to be set.

origin_access_identity_configuration
dict
only if origin_access_identity_configuration is true
Describes the origin access identity information configuration information. Requires origin_access_identity_id to be set.

streaming_distribution
dict
only if streaming_distribution is true
Describes the streaming information for the distribution. Requires distribution_id or domain_name_alias to be specified.

streaming_distribution_config
dict
only if streaming_distribution_config is true
Describes the streaming configuration information for the distribution. Requires distribution_id or domain_name_alias to be specified.

summary
dict
as default or if summary is true
Gives a summary of distributions, streaming distributions and origin access identities.



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Willem van Ketwich (@wilvk)

Hint

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