Class: Aws::S3::Types::PutBucketWebsiteRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  content_md5: "ContentMD5",
  website_configuration: { # required
    error_document: {
      key: "ObjectKey", # required
    },
    index_document: {
      suffix: "Suffix", # required
    },
    redirect_all_requests_to: {
      host_name: "HostName", # required
      protocol: "http", # accepts http, https
    },
    routing_rules: [
      {
        condition: {
          http_error_code_returned_equals: "HttpErrorCodeReturnedEquals",
          key_prefix_equals: "KeyPrefixEquals",
        },
        redirect: { # required
          host_name: "HostName",
          http_redirect_code: "HttpRedirectCode",
          protocol: "http", # accepts http, https
          replace_key_prefix_with: "ReplaceKeyPrefixWith",
          replace_key_with: "ReplaceKeyWith",
        },
      },
    ],
  },
  expected_bucket_owner: "AccountId",
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name.

Returns:

  • (String) 


11279
11280
11281
11282
11283
11284
11285
11286
 
# File 'lib/aws-sdk-s3/types.rb', line 11279

class PutBucketWebsiteRequest < Struct.new(
  :bucket,
  :content_md5,
  :website_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see [RFC 1864].

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

[1]: www.ietf.org/rfc/rfc1864.txt

Returns:

  • (String) 


11279
11280
11281
11282
11283
11284
11285
11286
 
# File 'lib/aws-sdk-s3/types.rb', line 11279

class PutBucketWebsiteRequest < Struct.new(
  :bucket,
  :content_md5,
  :website_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP ‘403 (Access Denied)` error.

Returns:

  • (String) 


11279
11280
11281
11282
11283
11284
11285
11286
 
# File 'lib/aws-sdk-s3/types.rb', line 11279

class PutBucketWebsiteRequest < Struct.new(
  :bucket,
  :content_md5,
  :website_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#website_configuration ⇒ Types::WebsiteConfiguration

Container for the request.

Returns:



11279
11280
11281
11282
11283
11284
11285
11286
 
# File 'lib/aws-sdk-s3/types.rb', line 11279

class PutBucketWebsiteRequest < Struct.new(
  :bucket,
  :content_md5,
  :website_configuration,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end