community.aws.cloudfront_info – Obtain facts about an AWS CloudFront distribution

Note

This plugin is part of the community.aws collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.cloudfront_info.

New in version 1.0.0: of community.aws

Synopsis

  • Gets information about an AWS CloudFront distribution.

  • This module was called cloudfront_facts before Ansible 2.9, returning ansible_facts. Note that the community.aws.cloudfront_info module no longer returns ansible_facts!

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
boolean
    Choices:
  • no ←
  • yes
Get all CloudFront lists that do not require parameters.
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    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.
distribution
boolean
    Choices:
  • no ←
  • yes
Get information about a distribution.
Requires distribution_id or domain_name_alias to be specified.
distribution_config
boolean
    Choices:
  • no ←
  • yes
Get the configuration information about a distribution.
Requires distribution_id or domain_name_alias to be specified.
distribution_id
string
The id of the CloudFront distribution. Used with distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.
domain_name_alias
string
Can be used instead of distribution_id - uses the aliased CNAME for the CloudFront distribution to get the distribution id where required.
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.

aliases: aws_endpoint_url, endpoint_url
invalidation
boolean
    Choices:
  • no ←
  • yes
Get information about an invalidation.
Requires invalidation_id to be specified.
invalidation_id
string
The id of the invalidation to get information about.
Used with invalidation.
list_distributions
boolean
    Choices:
  • no ←
  • yes
Get a list of CloudFront distributions.
list_distributions_by_web_acl_id
boolean
    Choices:
  • no ←
  • yes
Get a list of distributions using web acl id as a filter.
Requires web_acl_id to be set.
list_invalidations
boolean
    Choices:
  • no ←
  • yes
Get a list of invalidations.
Requires distribution_id or domain_name_alias to be specified.
list_origin_access_identities
boolean
    Choices:
  • no ←
  • yes
Get a list of CloudFront origin access identities.
Requires origin_access_identity_id to be set.
list_streaming_distributions
boolean
    Choices:
  • no ←
  • yes
Get a list of streaming distributions.
origin_access_identity
boolean
    Choices:
  • no ←
  • yes
Get information about an origin access identity.
Requires origin_access_identity_id to be specified.
origin_access_identity_config
boolean
    Choices:
  • no ←
  • yes
Get the configuration information about an origin access identity.
Requires origin_access_identity_id to be specified.
origin_access_identity_id
string
The id of the CloudFront origin access identity to get information about.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
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
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
streaming_distribution
boolean
    Choices:
  • no ←
  • yes
Get information about a specified RTMP distribution.
Requires distribution_id or domain_name_alias to be specified.
streaming_distribution_config
boolean
    Choices:
  • no ←
  • yes
Get the configuration information about a specified RTMP distribution.
Requires distribution_id or domain_name_alias to be specified.
summary
boolean
    Choices:
  • no ←
  • yes
Returns a summary of all distributions, streaming distributions and origin_access_identities.
This is the default behaviour if no option is selected.
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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE

  • 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.

- name: Get a summary of distributions
  community.aws.cloudfront_info:
    summary: true
  register: result

- name: Get information about a distribution
  community.aws.cloudfront_info:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
  register: result_did
- ansible.builtin.debug:
    msg: "{{ result_did['cloudfront']['my-cloudfront-distribution-id'] }}"

- name: Get information about a distribution using the CNAME of the cloudfront distribution.
  community.aws.cloudfront_info:
    distribution: true
    domain_name_alias: www.my-website.com
  register: result_website
- ansible.builtin.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.
- name: Gather facts
  community.aws.cloudfront_facts:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
- ansible.builtin.debug:
    msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"

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

- name: Get all information about an invalidation for a distribution.
  community.aws.cloudfront_info:
    invalidation: true
    distribution_id: my-cloudfront-distribution-id
    invalidation_id: my-cloudfront-invalidation-id

- name: Get all information about a CloudFront origin access identity.
  community.aws.cloudfront_info:
    origin_access_identity: true
    origin_access_identity_id: my-cloudfront-origin-access-identity-id

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

- name: Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
  community.aws.cloudfront_info:
    all_lists: true

Return Values

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

Key Returned Description
distribution
dictionary
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
dictionary
only if distribution_config is true
Facts about a CloudFront distribution's config. Requires distribution_id or domain_name_alias to be specified.
invalidation
dictionary
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
dictionary
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
dictionary
only if origin_access_identity_configuration is true
Describes the origin access identity information configuration information. Requires origin_access_identity_id to be set.
result
dictionary
always
Result dict not nested under the CloudFront ID to access results of module without the knowledge of that id as figuring out the DistributionId is usually the reason one uses this module in the first place.
streaming_distribution
dictionary
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
dictionary
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
dictionary
as default or if summary is true
Gives a summary of distributions, streaming distributions and origin access identities.


Authors

  • Willem van Ketwich (@wilvk)