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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cloudfront_distribution

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

• #alias ⇒ Object^?

  The name of an alias (CNAME) that is used in a distribution.

• #aliases ⇒ Array<String>, ...

  A I(list[]) of domain name aliases (CNAMEs) as strings to be used for the distribution.

• #cache_behaviors ⇒ Object^?

  A config element that is a I(list[]) of complex cache behavior objects to be specified for the distribution.

• #caller_reference ⇒ String^?

  A unique identifier for creating and updating cloudfront distributions.

• #comment ⇒ String^?

  A comment that describes the cloudfront distribution.

• #custom_error_responses ⇒ Object^?

  A config element that is a I(list[]) of complex custom error responses to be specified for the distribution.

• #default_cache_behavior ⇒ Hash^?

  A config element that is a complex object specifying the default cache behavior of the distribution.

• #default_origin_domain_name ⇒ String^?

  The domain name to use for an origin if no I(origins) have been specified.

• #default_origin_path ⇒ Object^?

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

• #default_root_object ⇒ Object^?

  A config element that specifies the path to request when the user requests the origin.

• #distribution_id ⇒ String^?

  The id of the cloudfront distribution.

• #e_tag ⇒ Object^?

  A unique identifier of a modified or existing distribution.

• #enabled ⇒ :yes, ...

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

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

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

• #ipv6_enabled ⇒ :yes, ...

  Determines whether IPv6 support is enabled or not.

• #logging ⇒ Hash^?

  A config element that is a complex object that defines logging for the distribution.

• #origins ⇒ Array<Hash>, ...

  A config element that is a I(list[]) of complex origin objects to be specified for the distribution.

• #price_class ⇒ :PriceClass_100, ...

  A string that specifies the pricing class of the distribution.

• #purge_aliases ⇒ :yes, ...

  Specifies whether existing aliases will be removed before adding new aliases.

• #purge_cache_behaviors ⇒ Boolean^?

  Whether to remove any cache behaviors that aren’t listed in I(cache_behaviors).

• #purge_custom_error_responses ⇒ Boolean^?

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

• #purge_origins ⇒ Boolean^?

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

• #purge_tags ⇒ :yes, ...

  Specifies whether existing tags will be removed before adding new tags.

• #restrictions ⇒ Object^?

  A config element that is a complex object that describes how a distribution should restrict it’s content.

• #state ⇒ :present, ...

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

• #tags ⇒ Hash^?

  Should be input as a dict() of key-value pairs.

• #viewer_certificate ⇒ Object^?

  A config element that is a complex object that specifies the encryption details of the distribution.

• #wait ⇒ :yes, ...

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

• #wait_timeout ⇒ Integer^?

  Specifies the duration in seconds to wait for a timeout of a cloudfront create or update.

• #web_acl_id ⇒ Object^?

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

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^?

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

attribute :alias

#aliases ⇒ Array<String>, ...

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

attribute :aliases

#cache_behaviors ⇒ Object^?

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

attribute :cache_behaviors

#caller_reference ⇒ String^?

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

attribute :caller_reference

#comment ⇒ String^?

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

attribute :comment

#custom_error_responses ⇒ Object^?

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

attribute :custom_error_responses

#default_cache_behavior ⇒ Hash^?

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

attribute :default_cache_behavior

#default_origin_domain_name ⇒ String^?

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

attribute :default_origin_domain_name

#default_origin_path ⇒ Object^?

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

attribute :default_origin_path

#default_root_object ⇒ Object^?

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

attribute :default_root_object

#distribution_id ⇒ String^?

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

attribute :distribution_id

#e_tag ⇒ Object^?

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

attribute :e_tag

#enabled ⇒ :yes, ...

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

attribute :enabled

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

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

attribute :http_version

#ipv6_enabled ⇒ :yes, ...

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

attribute :ipv6_enabled

#logging ⇒ Hash^?

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

attribute :logging

#origins ⇒ Array<Hash>, ...

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

attribute :origins

#price_class ⇒ :PriceClass_100, ...

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

attribute :price_class

#purge_aliases ⇒ :yes, ...

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

attribute :purge_aliases

#purge_cache_behaviors ⇒ Boolean^?

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

attribute :purge_cache_behaviors

#purge_custom_error_responses ⇒ Boolean^?

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

attribute :purge_custom_error_responses

#purge_origins ⇒ Boolean^?

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

attribute :purge_origins

#purge_tags ⇒ :yes, ...

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

attribute :purge_tags

#restrictions ⇒ Object^?

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

attribute :restrictions

#state ⇒ :present, ...

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

attribute :state

#tags ⇒ Hash^?

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

attribute :tags

#viewer_certificate ⇒ Object^?

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

attribute :viewer_certificate

#wait ⇒ :yes, ...

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

attribute :wait

#wait_timeout ⇒ Integer^?

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

attribute :wait_timeout

#web_acl_id ⇒ Object^?

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

attribute :web_acl_id