community.aws.cloudfront_response_headers_policy module – Create, update and delete response headers policies to be used in a Cloudfront distribution
Note
This module is part of the community.aws collection (version 5.5.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_response_headers_policy.
New in community.aws 3.2.0
Synopsis
Create, update and delete response headers policies to be used in a Cloudfront distribution for inserting custom headers
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Description of the policy |
|
CORS header config block Default: |
|
Custom headers config block. Define your own list of headers and values as a list Default: |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Name of the policy |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Security headers config block. For headers suchs as XSS-Protection, Content-Security-Policy or Strict-Transport-Security Default: |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Decides if the named policy should be absent or present Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: Creationg a Cloudfront header policy using all predefined header features and a custom header for demonstration
community.aws.cloudfront_response_headers_policy:
name: my-header-policy
comment: My header policy for all the headers
cors_config:
access_control_allow_origins:
items:
- 'https://foo.com/bar'
- 'https://bar.com/foo'
access_control_allow_headers:
items:
- 'X-Session-Id'
access_control_allow_methods:
items:
- GET
- OPTIONS
- HEAD
access_control_allow_credentials: true
access_control_expose_headers:
items:
- 'X-Session-Id'
access_control_max_age_sec: 1800
origin_override: true
security_headers_config:
xss_protection:
protection: true
report_uri: 'https://my.report-uri.com/foo/bar'
override: true
frame_options:
frame_option: 'SAMEORIGIN'
override: true
referrer_policy:
referrer_policy: 'same-origin'
override: true
content_security_policy:
content_security_policy: "frame-ancestors 'none'; report-uri https://my.report-uri.com/r/d/csp/enforce;"
override: true
content_type_options:
override: true
strict_transport_security:
include_subdomains: true
preload: true
access_control_max_age_sec: 63072000
override: true
custom_headers_config:
items:
- { header: 'X-Test-Header', value: 'Foo', override: true }
state: present
- name: Delete header policy
community.aws.cloudfront_response_headers_policy:
name: my-header-policy
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The policy’s information Returned: success |
|
ID of the policy Returned: always Sample: |
|
Timestamp of last modification of policy Returned: always Sample: |
|
The response headers config dict containing all the headers configured Returned: always |
|
Name of the policy Returned: always Sample: |