Class: Ansible::Ruby::Modules::Cloudfront_distribution

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb

Overview

Allows for easy creation, updating and deletion of CloudFront distributions.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#alias ⇒ Object?

Returns The name of an alias (CNAME) that is used in a distribution. This is used to effectively reference a distribution by its alias as an alias can only be used by one distribution per AWS account. This variable avoids having to provide the I(distribution_id) as well as the I(e_tag), or I(caller_reference) of an existing distribution.

Returns:

  • (Object, nil) —

    The name of an alias (CNAME) that is used in a distribution. This is used to effectively reference a distribution by its alias as an alias can only be used by one distribution per AWS account. This variable avoids having to provide the I(distribution_id) as well as the I(e_tag), or I(caller_reference) of an existing distribution.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 35

attribute :alias

#aliases ⇒ Array<String>, ...

Returns A I(list[]) of domain name aliases (CNAMEs) as strings to be used for the distribution. Each alias must be unique across all distribution for the AWS account.

Returns:

  • (Array<String>, String, nil) —

    A I(list[]) of domain name aliases (CNAMEs) as strings to be used for the distribution. Each alias must be unique across all distribution for the AWS account.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 38

attribute :aliases

#cache_behaviors ⇒ Object?

Returns A config element that is a I(list[]) of complex cache behavior objects to be specified for the distribution. The order of the list is preserved across runs unless C(purge_cache_behavior) is enabled. Each cache behavior comprises the attributes I(path_pattern) I(target_origin_id) I(forwarded_values) I(query_string) I(cookies) I(forward) I(whitelisted_names) I(headers[]) I(query_string_cache_keys[]) I(trusted_signers) I(enabled) I(items[]) I(viewer_protocol_policy) I(min_ttl) I(allowed_methods) I(items[]) I(cached_methods[]) I(smooth_streaming) I(default_ttl) I(max_ttl) I(compress) I(lambda_function_associations[]) I(field_level_encryption_id).

Returns:

  • (Object, nil) —

    A config element that is a I(list[]) of complex cache behavior objects to be specified for the distribution. The order of the list is preserved across runs unless C(purge_cache_behavior) is enabled. Each cache behavior comprises the attributes I(path_pattern) I(target_origin_id) I(forwarded_values) I(query_string) I(cookies) I(forward) I(whitelisted_names) I(headers[]) I(query_string_cache_keys[]) I(trusted_signers) I(enabled) I(items[]) I(viewer_protocol_policy) I(min_ttl) I(allowed_methods) I(items[]) I(cached_methods[]) I(smooth_streaming) I(default_ttl) I(max_ttl) I(compress) I(lambda_function_associations[]) I(field_level_encryption_id)



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 68

attribute :cache_behaviors

#caller_reference ⇒ String?

Returns A unique identifier for creating and updating cloudfront distributions. Each caller reference must be unique across all distributions. e.g. a caller reference used in a web distribution cannot be reused in a streaming distribution. This parameter can be used instead of I(distribution_id) to reference an existing distribution. If not specified, this defaults to a datetime stamp of the format ‘YYYY-MM-DDTHH:MM:SS.ffffff’.

Returns:

  • (String, nil) —

    A unique identifier for creating and updating cloudfront distributions. Each caller reference must be unique across all distributions. e.g. a caller reference used in a web distribution cannot be reused in a streaming distribution. This parameter can be used instead of I(distribution_id) to reference an existing distribution. If not specified, this defaults to a datetime stamp of the format ‘YYYY-MM-DDTHH:MM:SS.ffffff’.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 23

attribute :caller_reference

#comment ⇒ String?

Returns A comment that describes the cloudfront distribution. If not specified, it defaults to a generic message that it has been created with Ansible, and a datetime stamp.

Returns:

  • (String, nil) —

    A comment that describes the cloudfront distribution. If not specified, it defaults to a generic message that it has been created with Ansible, and a datetime stamp.



82
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 82

attribute :comment

#custom_error_responses ⇒ Object?

Returns A config element that is a I(list[]) of complex custom error responses to be specified for the distribution. This attribute configures custom http error messages returned to the user. Each custom error response object comprises the attributes I(error_code) I(reponse_page_path) I(response_code) I(error_caching_min_ttl).

Returns:

  • (Object, nil) —

    A config element that is a I(list[]) of complex custom error responses to be specified for the distribution. This attribute configures custom http error messages returned to the user. Each custom error response object comprises the attributes I(error_code) I(reponse_page_path) I(response_code) I(error_caching_min_ttl)



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 75

attribute :custom_error_responses

#default_cache_behavior ⇒ Hash?

Returns A config element that is a complex object specifying the default cache behavior of the distribution. If not specified, the I(target_origin_id) is defined as the I(target_origin_id) of the first valid I(cache_behavior) in I(cache_behaviors) with defaults. The default cache behavior comprises the attributes I(target_origin_id) I(forwarded_values) I(query_string) I(cookies) I(forward) I(whitelisted_names) I(headers[]) I(query_string_cache_keys[]) I(trusted_signers) I(enabled) I(items[]) I(viewer_protocol_policy) I(min_ttl) I(allowed_methods) I(items[]) I(cached_methods[]) I(smooth_streaming) I(default_ttl) I(max_ttl) I(compress) I(lambda_function_associations[]) I(lambda_function_arn) I(event_type) I(field_level_encryption_id).

Returns:

  • (Hash, nil) —

    A config element that is a complex object specifying the default cache behavior of the distribution. If not specified, the I(target_origin_id) is defined as the I(target_origin_id) of the first valid I(cache_behavior) in I(cache_behaviors) with defaults. The default cache behavior comprises the attributes I(target_origin_id) I(forwarded_values) I(query_string) I(cookies) I(forward) I(whitelisted_names) I(headers[]) I(query_string_cache_keys[]) I(trusted_signers) I(enabled) I(items[]) I(viewer_protocol_policy) I(min_ttl) I(allowed_methods) I(items[]) I(cached_methods[]) I(smooth_streaming) I(default_ttl) I(max_ttl) I(compress) I(lambda_function_associations[]) I(lambda_function_arn) I(event_type) I(field_level_encryption_id)



64
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 64

attribute :default_cache_behavior

#default_origin_domain_name ⇒ String?

Returns The domain name to use for an origin if no I(origins) have been specified. Should only be used on a first run of generating a distribution and not on subsequent runs. Should not be used in conjunction with I(distribution_id), I(caller_reference) or I(alias).

Returns:

  • (String, nil) —

    The domain name to use for an origin if no I(origins) have been specified. Should only be used on a first run of generating a distribution and not on subsequent runs. Should not be used in conjunction with I(distribution_id), I(caller_reference) or I(alias).



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 49

attribute :default_origin_domain_name

#default_origin_path ⇒ Object?

Returns The default origin path to specify for an origin if no I(origins) have been specified. Defaults to empty if not specified.

Returns:

  • (Object, nil) —

    The default origin path to specify for an origin if no I(origins) have been specified. Defaults to empty if not specified.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 53

attribute :default_origin_path

#default_root_object ⇒ Object?

Returns A config element that specifies the path to request when the user requests the origin. e.g. if specified as ‘index.html’, this maps to www.example.com/index.html when www.example.com is called by the user. This prevents the entire distribution origin from being exposed at the root.

Returns:

  • (Object, nil) —

    A config element that specifies the path to request when the user requests the origin. e.g. if specified as ‘index.html’, this maps to www.example.com/index.html when www.example.com is called by the user. This prevents the entire distribution origin from being exposed at the root.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 46

attribute :default_root_object

#distribution_id ⇒ String?

Returns The id of the cloudfront distribution. This parameter can be exchanged with I(alias) or I(caller_reference) and is used in conjunction with I(e_tag).

Returns:

  • (String, nil) —

    The id of the cloudfront distribution. This parameter can be exchanged with I(alias) or I(caller_reference) and is used in conjunction with I(e_tag).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 16

attribute :distribution_id

#e_tag ⇒ Object?

Returns A unique identifier of a modified or existing distribution. Used in conjunction with I(distribution_id). Is determined automatically if not specified.

Returns:

  • (Object, nil) —

    A unique identifier of a modified or existing distribution. Used in conjunction with I(distribution_id). Is determined automatically if not specified.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 20

attribute :e_tag

#enabled ⇒ :yes, ...

Returns A boolean value that specifies whether the distribution is enabled or disabled.

Returns:

  • (:yes, :no, nil) —

    A boolean value that specifies whether the distribution is enabled or disabled.



94
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 94

attribute :enabled

#http_version ⇒ :"http1.1", ...

Returns The version of the http protocol to use for the distribution.

Returns:

  • (:"http1.1", :http2, nil) —

    The version of the http protocol to use for the distribution.



107
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 107

attribute :http_version

#ipv6_enabled ⇒ :yes, ...

Returns Determines whether IPv6 support is enabled or not.

Returns:

  • (:yes, :no, nil) —

    Determines whether IPv6 support is enabled or not.



111
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 111

attribute :ipv6_enabled

#logging ⇒ Hash?

Returns A config element that is a complex object that defines logging for the distribution. The logging object comprises the attributes I(enabled) I(include_cookies) I(bucket) I(prefix).

Returns:

  • (Hash, nil) —

    A config element that is a complex object that defines logging for the distribution. The logging object comprises the attributes I(enabled) I(include_cookies) I(bucket) I(prefix)



86
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 86

attribute :logging

#origins ⇒ Array<Hash>, ...

Returns A config element that is a I(list[]) of complex origin objects to be specified for the distribution. Used for creating and updating distributions. Each origin item comprises the attributes I(id) I(domain_name) (defaults to default_origin_domain_name if not specified) I(origin_path) (defaults to default_origin_path if not specified) I(custom_headers[]) I(header_name) I(header_value) I(s3_origin_access_identity_enabled) I(custom_origin_config) I(http_port) I(https_port) I(origin_protocol_policy) I(origin_ssl_protocols[]) I(origin_read_timeout) I(origin_keepalive_timeout).

Returns:

  • (Array<Hash>, Hash, nil) —

    A config element that is a I(list[]) of complex origin objects to be specified for the distribution. Used for creating and updating distributions. Each origin item comprises the attributes I(id) I(domain_name) (defaults to default_origin_domain_name if not specified) I(origin_path) (defaults to default_origin_path if not specified) I(custom_headers[]) I(header_name) I(header_value) I(s3_origin_access_identity_enabled) I(custom_origin_config) I(http_port) I(https_port) I(origin_protocol_policy) I(origin_ssl_protocols[]) I(origin_read_timeout) I(origin_keepalive_timeout)



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 56

attribute :origins

#price_class ⇒ :PriceClass_100, ...

Returns A string that specifies the pricing class of the distribution. As per U(aws.amazon.com/cloudfront/pricing/) I(price_class=PriceClass_100) consists of the areas United States Canada Europe I(price_class=PriceClass_200) consists of the areas United States Canada Europe Hong Kong, Philippines, S. Korea, Singapore & Taiwan Japan India I(price_class=PriceClass_All) consists of the areas United States Canada Europe Hong Kong, Philippines, S. Korea, Singapore & Taiwan Japan India South America Australia.

Returns:

  • (:PriceClass_100, :PriceClass_200, :PriceClass_All, nil) —

    A string that specifies the pricing class of the distribution. As per U(aws.amazon.com/cloudfront/pricing/) I(price_class=PriceClass_100) consists of the areas United States Canada Europe I(price_class=PriceClass_200) consists of the areas United States Canada Europe Hong Kong, Philippines, S. Korea, Singapore & Taiwan Japan India I(price_class=PriceClass_All) consists of the areas United States Canada Europe Hong Kong, Philippines, S. Korea, Singapore & Taiwan Japan India South America Australia



90
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 90

attribute :price_class

#purge_aliases ⇒ :yes, ...

Returns Specifies whether existing aliases will be removed before adding new aliases. When I(purge_aliases=yes), existing aliases are removed and I(aliases) are added.

Returns:

  • (:yes, :no, nil) —

    Specifies whether existing aliases will be removed before adding new aliases. When I(purge_aliases=yes), existing aliases are removed and I(aliases) are added.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 42

attribute :purge_aliases

#purge_cache_behaviors ⇒ Boolean?

Returns Whether to remove any cache behaviors that aren’t listed in I(cache_behaviors). This switch also allows the reordering of cache_behaviors.

Returns:

  • (Boolean, nil) —

    Whether to remove any cache behaviors that aren’t listed in I(cache_behaviors). This switch also allows the reordering of cache_behaviors.



71
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 71

attribute :purge_cache_behaviors

#purge_custom_error_responses ⇒ Boolean?

Returns Whether to remove any custom error responses that aren’t listed in I(custom_error_responses).

Returns:

  • (Boolean, nil) —

    Whether to remove any custom error responses that aren’t listed in I(custom_error_responses)



78
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 78

attribute :purge_custom_error_responses

#purge_origins ⇒ Boolean?

Returns Whether to remove any origins that aren’t listed in I(origins).

Returns:

  • (Boolean, nil) —

    Whether to remove any origins that aren’t listed in I(origins)



60
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 60

attribute :purge_origins

#purge_tags ⇒ :yes, ...

Returns Specifies whether existing tags will be removed before adding new tags. When I(purge_tags=yes), existing tags are removed and I(tags) are added, if specified. If no tags are specified, it removes all existing tags for the distribution. When I(purge_tags=no), existing tags are kept and I(tags) are added, if specified.

Returns:

  • (:yes, :no, nil) —

    Specifies whether existing tags will be removed before adding new tags. When I(purge_tags=yes), existing tags are removed and I(tags) are added, if specified. If no tags are specified, it removes all existing tags for the distribution. When I(purge_tags=no), existing tags are kept and I(tags) are added, if specified.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 31

attribute :purge_tags

#restrictions ⇒ Object?

Returns A config element that is a complex object that describes how a distribution should restrict it’s content. The restriction object comprises the following attributes I(geo_restriction) I(restriction_type) I(items[]).

Returns:

  • (Object, nil) —

    A config element that is a complex object that describes how a distribution should restrict it’s content. The restriction object comprises the following attributes I(geo_restriction) I(restriction_type) I(items[])



101
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 101

attribute :restrictions

#state ⇒ :present, ...

Returns The desired state of the distribution present - creates a new distribution or updates an existing distribution. absent - deletes an existing distribution.

Returns:

  • (:present, :absent, nil) —

    The desired state of the distribution present - creates a new distribution or updates an existing distribution. absent - deletes an existing distribution.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 12

attribute :state

#tags ⇒ Hash?

Returns Should be input as a dict() of key-value pairs. Note that numeric keys or values must be wrapped in quotes. e.g. “Priority:” ‘1’.

Returns:

  • (Hash, nil) —

    Should be input as a dict() of key-value pairs. Note that numeric keys or values must be wrapped in quotes. e.g. “Priority:” ‘1’



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 27

attribute :tags

#viewer_certificate ⇒ Object?

Returns A config element that is a complex object that specifies the encryption details of the distribution. Comprises the following attributes I(cloudfront_default_certificate) I(iam_certificate_id) I(acm_certificate_arn) I(ssl_support_method) I(minimum_protocol_version) I(certificate) I(certificate_source).

Returns:

  • (Object, nil) —

    A config element that is a complex object that specifies the encryption details of the distribution. Comprises the following attributes I(cloudfront_default_certificate) I(iam_certificate_id) I(acm_certificate_arn) I(ssl_support_method) I(minimum_protocol_version) I(certificate) I(certificate_source)



98
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 98

attribute :viewer_certificate

#wait ⇒ :yes, ...

Returns Specifies whether the module waits until the distribution has completed processing the creation or update.

Returns:

  • (:yes, :no, nil) —

    Specifies whether the module waits until the distribution has completed processing the creation or update.



115
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 115

attribute :wait

#wait_timeout ⇒ Integer?

Returns Specifies the duration in seconds to wait for a timeout of a cloudfront create or update. Defaults to 1800 seconds (30 minutes).

Returns:

  • (Integer, nil) —

    Specifies the duration in seconds to wait for a timeout of a cloudfront create or update. Defaults to 1800 seconds (30 minutes).



119
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 119

attribute :wait_timeout

#web_acl_id ⇒ Object?

Returns The id of a Web Application Firewall (WAF) Access Control List (ACL).

Returns:

  • (Object, nil) —

    The id of a Web Application Firewall (WAF) Access Control List (ACL).



104
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_distribution.rb', line 104

attribute :web_acl_id