Class: Ansible::Ruby::Modules::Cloudfront_facts

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb

Overview

Gets information about an AWS CloudFront distribution

Instance Method Summary

• #all_lists ⇒ Boolean^?

  Get all cloudfront lists that do not require parameters.

• #distribution ⇒ Boolean^?

  Get information about a distribution.

• #distribution_config ⇒ Boolean^?

  Get the configuration information about a distribution.

• #distribution_id ⇒ String^?

  The id of the CloudFront distribution.

• #domain_name_alias ⇒ String^?

  Can be used instead of I(distribution_id) - uses the aliased CNAME for the cloudfront distribution to get the distribution id where required.

• #invalidation ⇒ Boolean^?

  Get information about an invalidation.

• #invalidation_id ⇒ String^?

  The id of the invalidation to get information about.

• #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.

• #list_invalidations ⇒ Boolean^?

  Get a list of invalidations.

• #list_origin_access_identities ⇒ Boolean^?

  Get a list of cloudfront origin access identities.

• #list_streaming_distributions ⇒ Boolean^?

  Get a list of streaming distributions.

• #origin_access_identity ⇒ Boolean^?

  Get information about an origin access identity.

• #origin_access_identity_config ⇒ Boolean^?

  Get the configuration information about an origin access identity.

• #origin_access_identity_id ⇒ String^?

  The id of the cloudfront origin access identity to get information about.

• #streaming_distribution ⇒ Boolean^?

  Get information about a specified RTMP distribution.

• #streaming_distribution_config ⇒ Boolean^?

  Get the configuration information about a specified RTMP distribution.

• #summary ⇒ Boolean^?

  Returns a summary of all distributions, streaming distributions and origin_access_identities.

• #web_acl_id ⇒ Object^?

  Used with I(list_distributions_by_web_acl_id).

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

#all_lists ⇒ Boolean^?

Returns Get all cloudfront lists that do not require parameters.

Returns:

• (Boolean, nil) —

  Get all cloudfront lists that do not require parameters.

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

attribute :all_lists

#distribution ⇒ Boolean^?

Returns Get information about a distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

Returns:

• (Boolean, nil) —

  Get information about a distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 43

attribute :distribution

#distribution_config ⇒ Boolean^?

Returns Get the configuration information about a distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

Returns:

• (Boolean, nil) —

  Get the configuration information about a distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 47

attribute :distribution_config

#distribution_id ⇒ String^?

Returns The id of the CloudFront distribution. Used with I(distribution), I(distribution_config), I(invalidation), I(streaming_distribution), I(streaming_distribution_config), I(list_invalidations).

Returns:

• (String, nil) —

  The id of the CloudFront distribution. Used with I(distribution), I(distribution_config), I(invalidation), I(streaming_distribution), I(streaming_distribution_config), I(list_invalidations).

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

attribute :distribution_id

#domain_name_alias ⇒ String^?

Returns Can be used instead of I(distribution_id) - uses the aliased CNAME for the cloudfront distribution to get the distribution id where required.

Returns:

• (String, nil) —

  Can be used instead of I(distribution_id) - uses the aliased CNAME for the cloudfront distribution to get the distribution id where required.

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

attribute :domain_name_alias

#invalidation ⇒ Boolean^?

Returns Get information about an invalidation. Requires I(invalidation_id) to be specified.

Returns:

• (Boolean, nil) —

  Get information about an invalidation. Requires I(invalidation_id) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 51

attribute :invalidation

#invalidation_id ⇒ String^?

Returns The id of the invalidation to get information about. Used with I(invalidation).

Returns:

• (String, nil) —

  The id of the invalidation to get information about. Used with I(invalidation).

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

attribute :invalidation_id

#list_distributions ⇒ Boolean^?

Returns Get a list of cloudfront distributions.

Returns:

• (Boolean, nil) —

  Get a list of cloudfront distributions.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 67

attribute :list_distributions

#list_distributions_by_web_acl_id ⇒ Boolean^?

Returns Get a list of distributions using web acl id as a filter. Requires I(web_acl_id) to be set.

Returns:

• (Boolean, nil) —

  Get a list of distributions using web acl id as a filter. Requires I(web_acl_id) to be set.

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

attribute :list_distributions_by_web_acl_id

#list_invalidations ⇒ Boolean^?

Returns Get a list of invalidations. Requires I(distribution_id) or I(domain_name_alias) to be specified.

Returns:

• (Boolean, nil) —

  Get a list of invalidations. Requires I(distribution_id) or I(domain_name_alias) to be specified.

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

attribute :list_invalidations

#list_origin_access_identities ⇒ Boolean^?

Returns Get a list of cloudfront origin access identities. Requires I(origin_access_identity_id) to be set.

Returns:

• (Boolean, nil) —

  Get a list of cloudfront origin access identities. Requires I(origin_access_identity_id) to be set.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 63

attribute :list_origin_access_identities

#list_streaming_distributions ⇒ Boolean^?

Returns Get a list of streaming distributions.

Returns:

• (Boolean, nil) —

  Get a list of streaming distributions.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 79

attribute :list_streaming_distributions

#origin_access_identity ⇒ Boolean^?

Returns Get information about an origin access identity. Requires I(origin_access_identity_id) to be specified.

Returns:

• (Boolean, nil) —

  Get information about an origin access identity. Requires I(origin_access_identity_id) to be specified.

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

attribute :origin_access_identity

#origin_access_identity_config ⇒ Boolean^?

Returns Get the configuration information about an origin access identity. Requires I(origin_access_identity_id) to be specified.

Returns:

• (Boolean, nil) —

  Get the configuration information about an origin access identity. Requires I(origin_access_identity_id) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 39

attribute :origin_access_identity_config

#origin_access_identity_id ⇒ String^?

Returns The id of the cloudfront origin access identity to get information about.

Returns:

• (String, nil) —

  The id of the cloudfront origin access identity to get information about.

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

attribute :origin_access_identity_id

#streaming_distribution ⇒ Boolean^?

Returns Get information about a specified RTMP distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

Returns:

• (Boolean, nil) —

  Get information about a specified RTMP distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 55

attribute :streaming_distribution

#streaming_distribution_config ⇒ Boolean^?

Returns Get the configuration information about a specified RTMP distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

Returns:

• (Boolean, nil) —

  Get the configuration information about a specified RTMP distribution. Requires I(distribution_id) or I(domain_name_alias) to be specified.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 59

attribute :streaming_distribution_config

#summary ⇒ Boolean^?

Returns a summary of all distributions, streaming distributions and origin_access_identities. This is the default behaviour if no option is selected.

Returns:

• (Boolean, nil) —

  Returns a summary of all distributions, streaming distributions and origin_access_identities. This is the default behaviour if no option is selected.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 83

attribute :summary

#web_acl_id ⇒ Object^?

Returns Used with I(list_distributions_by_web_acl_id).

Returns:

• (Object, nil) —

  Used with I(list_distributions_by_web_acl_id).

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/cloudfront_facts.rb', line 24

attribute :web_acl_id