129 lines
6.4 KiB
C++
129 lines
6.4 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/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/s3/model/TargetObjectKeyFormat.h>
|
|
#include <aws/s3/model/TargetGrant.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Xml
|
|
{
|
|
class XmlNode;
|
|
} // namespace Xml
|
|
} // namespace Utils
|
|
namespace S3
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Describes where logs are stored and the prefix that Amazon S3 assigns to all
|
|
* log object keys for a bucket. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html">PUT
|
|
* Bucket logging</a> in the <i>Amazon S3 API Reference</i>.</p><p><h3>See
|
|
* Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LoggingEnabled">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class LoggingEnabled
|
|
{
|
|
public:
|
|
AWS_S3_API LoggingEnabled();
|
|
AWS_S3_API LoggingEnabled(const Aws::Utils::Xml::XmlNode& xmlNode);
|
|
AWS_S3_API LoggingEnabled& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
|
|
|
|
AWS_S3_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
|
|
|
|
|
|
///@{
|
|
/**
|
|
* <p>Specifies the bucket where you want Amazon S3 to store server access logs.
|
|
* You can have your logs delivered to any bucket that you own, including the same
|
|
* bucket that is being logged. You can also configure multiple buckets to deliver
|
|
* their logs to the same target bucket. In this case, you should choose a
|
|
* different <code>TargetPrefix</code> for each source bucket so that the delivered
|
|
* log files can be distinguished by key.</p>
|
|
*/
|
|
inline const Aws::String& GetTargetBucket() const{ return m_targetBucket; }
|
|
inline bool TargetBucketHasBeenSet() const { return m_targetBucketHasBeenSet; }
|
|
inline void SetTargetBucket(const Aws::String& value) { m_targetBucketHasBeenSet = true; m_targetBucket = value; }
|
|
inline void SetTargetBucket(Aws::String&& value) { m_targetBucketHasBeenSet = true; m_targetBucket = std::move(value); }
|
|
inline void SetTargetBucket(const char* value) { m_targetBucketHasBeenSet = true; m_targetBucket.assign(value); }
|
|
inline LoggingEnabled& WithTargetBucket(const Aws::String& value) { SetTargetBucket(value); return *this;}
|
|
inline LoggingEnabled& WithTargetBucket(Aws::String&& value) { SetTargetBucket(std::move(value)); return *this;}
|
|
inline LoggingEnabled& WithTargetBucket(const char* value) { SetTargetBucket(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Container for granting information.</p> <p>Buckets that use the bucket owner
|
|
* enforced setting for Object Ownership don't support target grants. For more
|
|
* information, see <a
|
|
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions
|
|
* for server access log delivery</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
*/
|
|
inline const Aws::Vector<TargetGrant>& GetTargetGrants() const{ return m_targetGrants; }
|
|
inline bool TargetGrantsHasBeenSet() const { return m_targetGrantsHasBeenSet; }
|
|
inline void SetTargetGrants(const Aws::Vector<TargetGrant>& value) { m_targetGrantsHasBeenSet = true; m_targetGrants = value; }
|
|
inline void SetTargetGrants(Aws::Vector<TargetGrant>&& value) { m_targetGrantsHasBeenSet = true; m_targetGrants = std::move(value); }
|
|
inline LoggingEnabled& WithTargetGrants(const Aws::Vector<TargetGrant>& value) { SetTargetGrants(value); return *this;}
|
|
inline LoggingEnabled& WithTargetGrants(Aws::Vector<TargetGrant>&& value) { SetTargetGrants(std::move(value)); return *this;}
|
|
inline LoggingEnabled& AddTargetGrants(const TargetGrant& value) { m_targetGrantsHasBeenSet = true; m_targetGrants.push_back(value); return *this; }
|
|
inline LoggingEnabled& AddTargetGrants(TargetGrant&& value) { m_targetGrantsHasBeenSet = true; m_targetGrants.push_back(std::move(value)); return *this; }
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A prefix for all log object keys. If you store log files from multiple Amazon
|
|
* S3 buckets in a single bucket, you can use a prefix to distinguish which log
|
|
* files came from which bucket.</p>
|
|
*/
|
|
inline const Aws::String& GetTargetPrefix() const{ return m_targetPrefix; }
|
|
inline bool TargetPrefixHasBeenSet() const { return m_targetPrefixHasBeenSet; }
|
|
inline void SetTargetPrefix(const Aws::String& value) { m_targetPrefixHasBeenSet = true; m_targetPrefix = value; }
|
|
inline void SetTargetPrefix(Aws::String&& value) { m_targetPrefixHasBeenSet = true; m_targetPrefix = std::move(value); }
|
|
inline void SetTargetPrefix(const char* value) { m_targetPrefixHasBeenSet = true; m_targetPrefix.assign(value); }
|
|
inline LoggingEnabled& WithTargetPrefix(const Aws::String& value) { SetTargetPrefix(value); return *this;}
|
|
inline LoggingEnabled& WithTargetPrefix(Aws::String&& value) { SetTargetPrefix(std::move(value)); return *this;}
|
|
inline LoggingEnabled& WithTargetPrefix(const char* value) { SetTargetPrefix(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>Amazon S3 key format for log objects.</p>
|
|
*/
|
|
inline const TargetObjectKeyFormat& GetTargetObjectKeyFormat() const{ return m_targetObjectKeyFormat; }
|
|
inline bool TargetObjectKeyFormatHasBeenSet() const { return m_targetObjectKeyFormatHasBeenSet; }
|
|
inline void SetTargetObjectKeyFormat(const TargetObjectKeyFormat& value) { m_targetObjectKeyFormatHasBeenSet = true; m_targetObjectKeyFormat = value; }
|
|
inline void SetTargetObjectKeyFormat(TargetObjectKeyFormat&& value) { m_targetObjectKeyFormatHasBeenSet = true; m_targetObjectKeyFormat = std::move(value); }
|
|
inline LoggingEnabled& WithTargetObjectKeyFormat(const TargetObjectKeyFormat& value) { SetTargetObjectKeyFormat(value); return *this;}
|
|
inline LoggingEnabled& WithTargetObjectKeyFormat(TargetObjectKeyFormat&& value) { SetTargetObjectKeyFormat(std::move(value)); return *this;}
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_targetBucket;
|
|
bool m_targetBucketHasBeenSet = false;
|
|
|
|
Aws::Vector<TargetGrant> m_targetGrants;
|
|
bool m_targetGrantsHasBeenSet = false;
|
|
|
|
Aws::String m_targetPrefix;
|
|
bool m_targetPrefixHasBeenSet = false;
|
|
|
|
TargetObjectKeyFormat m_targetObjectKeyFormat;
|
|
bool m_targetObjectKeyFormatHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace S3
|
|
} // namespace Aws
|