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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name.

Returns:

  • (String)

12860
12861
12862
12863
12864
12865
12866
12867
12868
# File 'lib/aws-sdk-s3/types.rb', line 12860

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

#checksum_algorithmString

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding `x-amz-checksum` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

If you provide an individual checksum, Amazon S3 ignores any provided `ChecksumAlgorithm` parameter.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

  • (String)

12860
12861
12862
12863
12864
12865
12866
12867
12868
# File 'lib/aws-sdk-s3/types.rb', line 12860

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

#content_md5String

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 Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

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

Returns:

  • (String)

12860
12861
12862
12863
12864
12865
12866
12867
12868
# File 'lib/aws-sdk-s3/types.rb', line 12860

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

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code `403 Forbidden` (access denied).

Returns:

  • (String)

12860
12861
12862
12863
12864
12865
12866
12867
12868
# File 'lib/aws-sdk-s3/types.rb', line 12860

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

#website_configurationTypes::WebsiteConfiguration

Container for the request.


12860
12861
12862
12863
12864
12865
12866
12867
12868
# File 'lib/aws-sdk-s3/types.rb', line 12860

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