Class: Aws::S3::Types::IndexDocument

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::IndexDocument

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass IndexDocument data as a hash:

{
  suffix: "Suffix", # required
}

Container for the ‘Suffix` element.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #suffix ⇒ String

  A suffix that is appended to a request that is for a directory on the website endpoint (for example,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 be empty and must not include a slash character.

Instance Attribute Details

#suffix ⇒ String

A suffix that is appended to a request that is for a directory on the website endpoint (for example,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 be empty and must not include a slash character.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [ XML related object key constraints].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 7526

class IndexDocument < Struct.new(
  :suffix)
  SENSITIVE = []
  include Aws::Structure
end