Class: Ansible::Ruby::Modules::S3_website

Inherits:

Base

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

Defined in:

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

Overview

Configure an s3 bucket as a website

Instance Method Summary

• #error_key ⇒ String^?

  The object key name to use when a 4XX class error occurs.

• #name ⇒ String

  Name of the s3 bucket.

• #redirect_all_requests ⇒ String^?

  Describes the redirect behavior for every request to this s3 bucket website endpoint.

• #region ⇒ Object^?

  AWS region to create the bucket in.

• #state ⇒ :present, ...

  Add or remove s3 website configuration.

• #suffix ⇒ String^?

  Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html).

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

#error_key ⇒ String^?

Returns The object key name to use when a 4XX class error occurs. To remove an error key, set to None.

Returns:

• (String, nil) —

  The object key name to use when a 4XX class error occurs. To remove an error key, set to None.

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

attribute :error_key

#name ⇒ String

Returns Name of the s3 bucket.

Returns:

• (String) —

  Name of the s3 bucket

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

attribute :name

#redirect_all_requests ⇒ String^?

Returns Describes the redirect behavior for every request to this s3 bucket website endpoint.

Returns:

• (String, nil) —

  Describes the redirect behavior for every request to this s3 bucket website endpoint

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

attribute :redirect_all_requests

#region ⇒ Object^?

Returns AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard.rn.

Returns:

• (Object, nil) —

  AWS region to create the bucket in. If not set then the value of the AWS_REGION and EC2_REGION environment variables are checked, followed by the aws_region and ec2_region settings in the Boto config file. If none of those are set the region defaults to the S3 Location: US Standard.rn

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

attribute :region

#state ⇒ :present, ...

Returns Add or remove s3 website configuration.

Returns:

• (:present, :absent, nil) —

  Add or remove s3 website configuration

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

attribute :state

#suffix ⇒ String^?

Returns Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not include a slash character.rn.

Returns:

• (String, nil) —

  Suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html). The suffix must not include a slash character.rn

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

attribute :suffix