172 lines
10 KiB
C++
172 lines
10 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/s3/model/BucketLoggingStatus.h>
|
|
#include <aws/s3/model/ChecksumAlgorithm.h>
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Http
|
|
{
|
|
class URI;
|
|
} //namespace Http
|
|
namespace S3
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class PutBucketLoggingRequest : public S3Request
|
|
{
|
|
public:
|
|
AWS_S3_API PutBucketLoggingRequest();
|
|
|
|
// 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 "PutBucketLogging"; }
|
|
|
|
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;
|
|
AWS_S3_API Aws::String GetChecksumAlgorithmName() 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 for which to set the logging parameters.</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 PutBucketLoggingRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;}
|
|
inline PutBucketLoggingRequest& WithBucket(const char* value) { SetBucket(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Container for logging status information.</p>
|
|
*/
|
|
inline const BucketLoggingStatus& GetBucketLoggingStatus() const{ return m_bucketLoggingStatus; }
|
|
inline bool BucketLoggingStatusHasBeenSet() const { return m_bucketLoggingStatusHasBeenSet; }
|
|
inline void SetBucketLoggingStatus(const BucketLoggingStatus& value) { m_bucketLoggingStatusHasBeenSet = true; m_bucketLoggingStatus = value; }
|
|
inline void SetBucketLoggingStatus(BucketLoggingStatus&& value) { m_bucketLoggingStatusHasBeenSet = true; m_bucketLoggingStatus = std::move(value); }
|
|
inline PutBucketLoggingRequest& WithBucketLoggingStatus(const BucketLoggingStatus& value) { SetBucketLoggingStatus(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithBucketLoggingStatus(BucketLoggingStatus&& value) { SetBucketLoggingStatus(std::move(value)); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The MD5 hash of the <code>PutBucketLogging</code> request body.</p> <p>For
|
|
* requests made using the Amazon Web Services Command Line Interface (CLI) or
|
|
* Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
*/
|
|
inline const Aws::String& GetContentMD5() const{ return m_contentMD5; }
|
|
inline bool ContentMD5HasBeenSet() const { return m_contentMD5HasBeenSet; }
|
|
inline void SetContentMD5(const Aws::String& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = value; }
|
|
inline void SetContentMD5(Aws::String&& value) { m_contentMD5HasBeenSet = true; m_contentMD5 = std::move(value); }
|
|
inline void SetContentMD5(const char* value) { m_contentMD5HasBeenSet = true; m_contentMD5.assign(value); }
|
|
inline PutBucketLoggingRequest& WithContentMD5(const Aws::String& value) { SetContentMD5(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithContentMD5(Aws::String&& value) { SetContentMD5(std::move(value)); return *this;}
|
|
inline PutBucketLoggingRequest& WithContentMD5(const char* value) { SetContentMD5(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Indicates the algorithm used to create the checksum for the object when you
|
|
* use the SDK. This header will not provide any additional functionality if you
|
|
* don't use the SDK. When you send this header, there must be a corresponding
|
|
* <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent.
|
|
* Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad
|
|
* Request</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
|
|
* object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide
|
|
* an individual checksum, Amazon S3 ignores any provided
|
|
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
*/
|
|
inline const ChecksumAlgorithm& GetChecksumAlgorithm() const{ return m_checksumAlgorithm; }
|
|
inline bool ChecksumAlgorithmHasBeenSet() const { return m_checksumAlgorithmHasBeenSet; }
|
|
inline void SetChecksumAlgorithm(const ChecksumAlgorithm& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = value; }
|
|
inline void SetChecksumAlgorithm(ChecksumAlgorithm&& value) { m_checksumAlgorithmHasBeenSet = true; m_checksumAlgorithm = std::move(value); }
|
|
inline PutBucketLoggingRequest& WithChecksumAlgorithm(const ChecksumAlgorithm& value) { SetChecksumAlgorithm(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithChecksumAlgorithm(ChecksumAlgorithm&& value) { SetChecksumAlgorithm(std::move(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>
|
|
*/
|
|
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 PutBucketLoggingRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;}
|
|
inline PutBucketLoggingRequest& 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 PutBucketLoggingRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;}
|
|
inline PutBucketLoggingRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;}
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; }
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; }
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; }
|
|
inline PutBucketLoggingRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; }
|
|
inline PutBucketLoggingRequest& 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;
|
|
|
|
BucketLoggingStatus m_bucketLoggingStatus;
|
|
bool m_bucketLoggingStatusHasBeenSet = false;
|
|
|
|
Aws::String m_contentMD5;
|
|
bool m_contentMD5HasBeenSet = false;
|
|
|
|
ChecksumAlgorithm m_checksumAlgorithm;
|
|
bool m_checksumAlgorithmHasBeenSet = 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
|