Try SpotterObtain facts about an AWS CloudFront distribution
| "added in version" 2.3 of ansible.builtin"
Authors: Willem van Ketwich (@wilvk)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Gets information about an AWS CloudFront distribution
This module was called C(cloudfront_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(cloudfront_info) module no longer returns C(ansible_facts)!
# 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
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
summary:
default: false
description:
- Returns a summary of all distributions, streaming distributions and origin_access_identities.
This is the default behaviour if no option is selected.
required: false
type: bool
all_lists:
default: false
description:
- Get all cloudfront lists that do not require parameters.
required: false
type: bool
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
web_acl_id:
description:
- Used with I(list_distributions_by_web_acl_id).
required: false
distribution:
default: false
description:
- Get information about a distribution. Requires I(distribution_id) or I(domain_name_alias)
to be specified.
required: false
type: bool
invalidation:
default: false
description:
- Get information about an invalidation. Requires I(invalidation_id) to be specified.
required: false
type: bool
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
distribution_id:
description:
- The id of the CloudFront distribution. Used with I(distribution), I(distribution_config),
I(invalidation), I(streaming_distribution), I(streaming_distribution_config), I(list_invalidations).
required: false
invalidation_id:
description:
- The id of the invalidation to get information about. Used with I(invalidation).
required: false
domain_name_alias:
description:
- Can be used instead of I(distribution_id) - uses the aliased CNAME for the cloudfront
distribution to get the distribution id where required.
required: false
list_distributions:
default: false
description:
- Get a list of cloudfront distributions.
required: false
type: bool
list_invalidations:
default: false
description:
- Get a list of invalidations. Requires I(distribution_id) or I(domain_name_alias)
to be specified.
required: false
type: bool
distribution_config:
default: false
description:
- Get the configuration information about a distribution. Requires I(distribution_id)
or I(domain_name_alias) to be specified.
required: false
type: bool
origin_access_identity:
default: false
description:
- Get information about an origin access identity. Requires I(origin_access_identity_id)
to be specified.
required: false
type: bool
streaming_distribution:
default: false
description:
- Get information about a specified RTMP distribution. Requires I(distribution_id)
or I(domain_name_alias) to be specified.
required: false
type: bool
origin_access_identity_id:
description:
- The id of the cloudfront origin access identity to get information about.
required: false
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
list_streaming_distributions:
default: false
description:
- Get a list of streaming distributions.
required: false
type: bool
list_origin_access_identities:
default: false
description:
- Get a list of cloudfront origin access identities. Requires I(origin_access_identity_id)
to be set.
required: false
type: bool
origin_access_identity_config:
default: false
description:
- Get the configuration information about an origin access identity. Requires I(origin_access_identity_id)
to be specified.
required: false
type: bool
streaming_distribution_config:
default: false
description:
- Get the configuration information about a specified RTMP distribution. Requires
I(distribution_id) or I(domain_name_alias) to be specified.
required: false
type: bool
list_distributions_by_web_acl_id:
default: false
description:
- Get a list of distributions using web acl id as a filter. Requires I(web_acl_id)
to be set.
required: false
type: bool
distribution:
description: 'Facts about a cloudfront distribution. Requires I(distribution_id)
or I(domain_name_alias) to be specified. Requires I(origin_access_identity_id)
to be set.
'
returned: only if distribution is true
type: dict
distribution_config:
description: 'Facts about a cloudfront distribution''s config. Requires I(distribution_id)
or I(domain_name_alias) to be specified.
'
returned: only if I(distribution_config) is true
type: dict
invalidation:
description: 'Describes the invalidation information for the distribution. Requires
I(invalidation_id) to be specified and either I(distribution_id) or I(domain_name_alias.)
'
returned: only if invalidation is true
type: dict
origin_access_identity:
description: Describes the origin access identity information. Requires I(origin_access_identity_id)
to be set.
returned: only if I(origin_access_identity) is true
type: dict
origin_access_identity_configuration:
description: Describes the origin access identity information configuration information.
Requires I(origin_access_identity_id) to be set.
returned: only if I(origin_access_identity_configuration) is true
type: dict
result:
description: '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.
'
returned: always
type: dict
streaming_distribution:
description: 'Describes the streaming information for the distribution. Requires
I(distribution_id) or I(domain_name_alias) to be specified.
'
returned: only if I(streaming_distribution) is true
type: dict
streaming_distribution_config:
description: 'Describes the streaming configuration information for the distribution.
Requires I(distribution_id) or I(domain_name_alias) to be specified.
'
returned: only if I(streaming_distribution_config) is true
type: dict
summary:
description: Gives a summary of distributions, streaming distributions and origin
access identities.
returned: as default or if summary is true
type: dict