community.aws.cloudfront_info module – Obtain facts about an AWS CloudFront distribution
Note
This module is part of the community.aws collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.cloudfront_info
.
New in community.aws 1.0.0
Synopsis
Gets information about an AWS CloudFront distribution.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
Get all CloudFront lists that do not require parameters. Choices:
|
|
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. |
|
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. |
|
A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
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. |
|
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. Choices:
|
|
Get information about a distribution. Requires distribution_id or domain_name_alias to be specified. Choices:
|
|
Get the configuration information about a distribution. Requires distribution_id or domain_name_alias to be specified. Choices:
|
|
The id of the CloudFront distribution. Used with distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations. |
|
Can be used instead of distribution_id - uses the aliased CNAME for the CloudFront distribution to get the distribution id where required. |
|
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. |
|
Get information about an invalidation. Requires invalidation_id to be specified. Choices:
|
|
The id of the invalidation to get information about. Used with invalidation. |
|
Get a list of CloudFront distributions. Choices:
|
|
Get a list of distributions using web acl id as a filter. Requires web_acl_id to be set. Choices:
|
|
Get a list of invalidations. Requires distribution_id or domain_name_alias to be specified. Choices:
|
|
Get a list of CloudFront origin access identities. Requires origin_access_identity_id to be set. Choices:
|
|
Get a list of streaming distributions. Choices:
|
|
Get information about an origin access identity. Requires origin_access_identity_id to be specified. Choices:
|
|
Get the configuration information about an origin access identity. Requires origin_access_identity_id to be specified. Choices:
|
|
The id of the CloudFront origin access identity to get information about. |
|
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. |
|
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 |
|
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_session_token and session_token have been added in version 3.2.0. |
|
Get information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified. Choices:
|
|
Get the configuration information about a specified RTMP distribution. Requires distribution_id or domain_name_alias to be specified. Choices:
|
|
Returns a summary of all distributions, streaming distributions and origin_access_identities. This is the default behaviour if no option is selected. Choices:
|
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
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_PROFILE
orAWS_DEFAULT_PROFILE
,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
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
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'] }}"
- 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 |
Description |
---|---|
Facts about a CloudFront distribution. Requires distribution_id or domain_name_alias to be specified. Requires origin_access_identity_id to be set. Returned: only if distribution is true |
|
Facts about a CloudFront distribution’s config. Requires distribution_id or domain_name_alias to be specified. Returned: only if distribution_config is true |
|
Describes the invalidation information for the distribution. Requires invalidation_id to be specified and either distribution_id or domain_name_alias. Returned: only if invalidation is true |
|
Describes the origin access identity information. Requires origin_access_identity_id to be set. Returned: only if origin_access_identity is true |
|
Describes the origin access identity information configuration information. Requires origin_access_identity_id to be set. Returned: only if origin_access_identity_configuration is true |
|
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 |
|
Describes the streaming information for the distribution. Requires distribution_id or domain_name_alias to be specified. Returned: only if streaming_distribution is true |
|
Describes the streaming configuration information for the distribution. Requires distribution_id or domain_name_alias to be specified. Returned: only if streaming_distribution_config is true |
|
Gives a summary of distributions, streaming distributions and origin access identities. Returned: as default or if summary is true |