Class: Aws::S3::Types::PutBucketAccelerateConfigurationRequest

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 PutBucketAccelerateConfigurationRequest data as a hash:

{
  bucket: "BucketName", # required
  accelerate_configuration: { # required
    status: "Enabled", # accepts Enabled, Suspended
  },
  expected_bucket_owner: "AccountId",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accelerate_configurationTypes::AccelerateConfiguration

Container for setting the transfer acceleration state.


11282
11283
11284
11285
11286
11287
11288
11289
# File 'lib/aws-sdk-s3/types.rb', line 11282

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

#bucketString

The name of the bucket for which the accelerate configuration is set.

Returns:

  • (String)

11282
11283
11284
11285
11286
11287
11288
11289
# File 'lib/aws-sdk-s3/types.rb', line 11282

class PutBucketAccelerateConfigurationRequest < Struct.new(
  :bucket,
  :accelerate_configuration,
  :expected_bucket_owner,
  :checksum_algorithm)
  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)

11282
11283
11284
11285
11286
11287
11288
11289
# File 'lib/aws-sdk-s3/types.rb', line 11282

class PutBucketAccelerateConfigurationRequest < Struct.new(
  :bucket,
  :accelerate_configuration,
  :expected_bucket_owner,
  :checksum_algorithm)
  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)

11282
11283
11284
11285
11286
11287
11288
11289
# File 'lib/aws-sdk-s3/types.rb', line 11282

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