123 lines
7.5 KiB
C++
123 lines
7.5 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/s3/S3_EXPORTS.h>
|
|
#include <aws/s3/S3Request.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Http
|
|
{
|
|
class URI;
|
|
} //namespace Http
|
|
namespace S3
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class GetBucketEncryptionRequest : public S3Request
|
|
{
|
|
public:
|
|
AWS_S3_API GetBucketEncryptionRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "GetBucketEncryption"; }
|
|
|
|
AWS_S3_API Aws::String SerializePayload() const override;
|
|
|
|
AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
|
|
|
|
AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
AWS_S3_API bool HasEmbeddedError(IOStream &body, const Http::HeaderValueCollection &header) const override;
|
|
/**
|
|
* Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.
|
|
*/
|
|
AWS_S3_API EndpointParameters GetEndpointContextParams() const override;
|
|
|
|
///@{
|
|
/**
|
|
* <p>The name of the bucket from which the server-side encryption configuration is
|
|
* retrieved.</p> <p> <b>Directory buckets </b> - When you use this operation with
|
|
* a directory bucket, you must use path-style requests in the format
|
|
* <code>https://s3express-control.<i>region_code</i>.amazonaws.com/<i>bucket-name</i>
|
|
* </code>. Virtual-hosted-style requests aren't supported. Directory bucket names
|
|
* must be unique in the chosen Availability Zone. Bucket names must also follow
|
|
* the format <code> <i>bucket_base_name</i>--<i>az_id</i>--x-s3</code> (for
|
|
* example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For
|
|
* information about bucket naming restrictions, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory
|
|
* bucket naming rules</a> in the <i>Amazon S3 User Guide</i> </p>
|
|
*/
|
|
inline const Aws::String& GetBucket() const{ return m_bucket; }
|
|
inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; }
|
|
inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; }
|
|
inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); }
|
|
inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); }
|
|
inline GetBucketEncryptionRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
|
|
inline GetBucketEncryptionRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
|
|
inline GetBucketEncryptionRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The account ID of the expected bucket owner. If the account ID that you
|
|
* provide does not match the actual owner of the bucket, the request fails with
|
|
* the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
* <p>For directory buckets, this header is not supported in this API operation. If
|
|
* you specify this header, the request fails with the HTTP status code <code>501
|
|
* Not Implemented</code>.</p>
|
|
*/
|
|
inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; }
|
|
inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; }
|
|
inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; }
|
|
inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); }
|
|
inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); }
|
|
inline GetBucketEncryptionRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
|
|
inline GetBucketEncryptionRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
|
|
inline GetBucketEncryptionRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; }
|
|
inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; }
|
|
inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; }
|
|
inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); }
|
|
inline GetBucketEncryptionRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
|
|
inline GetBucketEncryptionRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline GetBucketEncryptionRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_bucket;
|
|
bool m_bucketHasBeenSet = false;
|
|
|
|
Aws::String m_expectedBucketOwner;
|
|
bool m_expectedBucketOwnerHasBeenSet = false;
|
|
|
|
Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag;
|
|
bool m_customizedAccessLogTagHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace S3
|
|
} // namespace Aws
|