/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include
#include
#include
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace S3
{
namespace Model
{
/**
* The container element for optionally specifying the default Object Lock
* retention settings for new objects placed in the specified bucket.
* -
The DefaultRetention settings require both a mode and
* a period.
-
The DefaultRetention period can be
* either Days or Years but you must select one. You
* cannot specify Days and Years at the same time.
*
See Also:
AWS
* API Reference
*/
class DefaultRetention
{
public:
AWS_S3_API DefaultRetention();
AWS_S3_API DefaultRetention(const Aws::Utils::Xml::XmlNode& xmlNode);
AWS_S3_API DefaultRetention& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
AWS_S3_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
///@{
/**
* The default Object Lock retention mode you want to apply to new objects
* placed in the specified bucket. Must be used with either Days or
* Years.
*/
inline const ObjectLockRetentionMode& GetMode() const{ return m_mode; }
inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; }
inline void SetMode(const ObjectLockRetentionMode& value) { m_modeHasBeenSet = true; m_mode = value; }
inline void SetMode(ObjectLockRetentionMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); }
inline DefaultRetention& WithMode(const ObjectLockRetentionMode& value) { SetMode(value); return *this;}
inline DefaultRetention& WithMode(ObjectLockRetentionMode&& value) { SetMode(std::move(value)); return *this;}
///@}
///@{
/**
* The number of days that you want to specify for the default retention period.
* Must be used with Mode.
*/
inline int GetDays() const{ return m_days; }
inline bool DaysHasBeenSet() const { return m_daysHasBeenSet; }
inline void SetDays(int value) { m_daysHasBeenSet = true; m_days = value; }
inline DefaultRetention& WithDays(int value) { SetDays(value); return *this;}
///@}
///@{
/**
* The number of years that you want to specify for the default retention
* period. Must be used with Mode.
*/
inline int GetYears() const{ return m_years; }
inline bool YearsHasBeenSet() const { return m_yearsHasBeenSet; }
inline void SetYears(int value) { m_yearsHasBeenSet = true; m_years = value; }
inline DefaultRetention& WithYears(int value) { SetYears(value); return *this;}
///@}
private:
ObjectLockRetentionMode m_mode;
bool m_modeHasBeenSet = false;
int m_days;
bool m_daysHasBeenSet = false;
int m_years;
bool m_yearsHasBeenSet = false;
};
} // namespace Model
} // namespace S3
} // namespace Aws