cloudfront_info – Obtain facts about an AWS CloudFront distribution¶
Synopsis¶
- Gets information about an AWS CloudFront distribution
- This module was called
cloudfront_facts
before Ansible 2.9, returningansible_facts
. Note that the cloudfront_info module no longer returnsansible_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¶
Parameter | Choices/Defaults | Comments |
---|---|---|
all_lists
boolean
|
|
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.
aliases: ec2_access_key, access_key |
|
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.
aliases: ec2_secret_key, secret_key |
|
debug_botocore_endpoint_logs
boolean
added in 2.8 |
|
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
|
|
Get information about a distribution. Requires distribution_id or domain_name_alias to be specified.
|
distribution_config
boolean
|
|
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
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.
|
|
invalidation
boolean
|
|
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
boolean
|
|
Get a list of cloudfront distributions.
|
list_distributions_by_web_acl_id
boolean
|
|
Get a list of distributions using web acl id as a filter. Requires web_acl_id to be set.
|
list_invalidations
boolean
|
|
Get a list of invalidations. Requires distribution_id or domain_name_alias to be specified.
|
list_origin_access_identities
boolean
|
|
Get a list of cloudfront origin access identities. Requires origin_access_identity_id to be set.
|
list_streaming_distributions
boolean
|
|
Get a list of streaming distributions.
|
origin_access_identity
boolean
|
|
Get information about an origin access identity. Requires origin_access_identity_id to be specified.
|
origin_access_identity_config
boolean
|
|
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
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
|
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.
aliases: access_token |
|
streaming_distribution
boolean
|
|
Get information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified.
|
streaming_distribution_config
boolean
|
|
Get the configuration information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified.
|
summary
boolean
|
|
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
|
|
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
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¶
# 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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.