/** * 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 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 AWS_S3_API DefaultRetention { public: DefaultRetention(); DefaultRetention(const Aws::Utils::Xml::XmlNode& xmlNode); DefaultRetention& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); 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; } /** *

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 bool ModeHasBeenSet() const { return m_modeHasBeenSet; } /** *

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 void SetMode(const ObjectLockRetentionMode& value) { m_modeHasBeenSet = true; m_mode = value; } /** *

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 void SetMode(ObjectLockRetentionMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); } /** *

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 DefaultRetention& WithMode(const ObjectLockRetentionMode& value) { SetMode(value); return *this;} /** *

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 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; } /** *

The number of days that you want to specify for the default retention period. * Must be used with Mode.

*/ inline bool DaysHasBeenSet() const { return m_daysHasBeenSet; } /** *

The number of days that you want to specify for the default retention period. * Must be used with Mode.

*/ inline void SetDays(int value) { m_daysHasBeenSet = true; m_days = value; } /** *

The number of days that you want to specify for the default retention period. * Must be used with Mode.

*/ 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; } /** *

The number of years that you want to specify for the default retention * period. Must be used with Mode.

*/ inline bool YearsHasBeenSet() const { return m_yearsHasBeenSet; } /** *

The number of years that you want to specify for the default retention * period. Must be used with Mode.

*/ inline void SetYears(int value) { m_yearsHasBeenSet = true; m_years = value; } /** *

The number of years that you want to specify for the default retention * period. Must be used with Mode.

*/ inline DefaultRetention& WithYears(int value) { SetYears(value); return *this;} private: ObjectLockRetentionMode m_mode; bool m_modeHasBeenSet; int m_days; bool m_daysHasBeenSet; int m_years; bool m_yearsHasBeenSet; }; } // namespace Model } // namespace S3 } // namespace Aws