xref: /dports/devel/aws-sdk-cpp/aws-sdk-cpp-1.9.129/aws-cpp-sdk-backup/include/aws/backup/model/PutBackupVaultLockConfigurationRequest.h

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/backup/Backup_EXPORTS.h>
#include <aws/backup/BackupRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>

namespace Aws
{
namespace Backup
{
namespace Model
{

  /**
   */
  class AWS_BACKUP_API PutBackupVaultLockConfigurationRequest : public BackupRequest
  {
  public:
    PutBackupVaultLockConfigurationRequest();

    // 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 "PutBackupVaultLockConfiguration"; }

    Aws::String SerializePayload() const override;


    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline const Aws::String& GetBackupVaultName() const{ return m_backupVaultName; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline bool BackupVaultNameHasBeenSet() const { return m_backupVaultNameHasBeenSet; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline void SetBackupVaultName(const Aws::String& value) { m_backupVaultNameHasBeenSet = true; m_backupVaultName = value; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline void SetBackupVaultName(Aws::String&& value) { m_backupVaultNameHasBeenSet = true; m_backupVaultName = std::move(value); }

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline void SetBackupVaultName(const char* value) { m_backupVaultNameHasBeenSet = true; m_backupVaultName.assign(value); }

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithBackupVaultName(const Aws::String& value) { SetBackupVaultName(value); return *this;}

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithBackupVaultName(Aws::String&& value) { SetBackupVaultName(std::move(value)); return *this;}

    /**
     * <p>The Backup Vault Lock configuration that specifies the name of the backup
     * vault it protects.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithBackupVaultName(const char* value) { SetBackupVaultName(value); return *this;}


    /**
     * <p>The Backup Vault Lock configuration that specifies the minimum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to retain certain data
     * for at least seven years (2555 days).</p> <p>If this parameter is not specified,
     * Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or longer than the minimum retention period. If
     * the job's retention period is shorter than that minimum retention period, then
     * the vault fails that backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline long long GetMinRetentionDays() const{ return m_minRetentionDays; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the minimum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to retain certain data
     * for at least seven years (2555 days).</p> <p>If this parameter is not specified,
     * Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or longer than the minimum retention period. If
     * the job's retention period is shorter than that minimum retention period, then
     * the vault fails that backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline bool MinRetentionDaysHasBeenSet() const { return m_minRetentionDaysHasBeenSet; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the minimum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to retain certain data
     * for at least seven years (2555 days).</p> <p>If this parameter is not specified,
     * Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or longer than the minimum retention period. If
     * the job's retention period is shorter than that minimum retention period, then
     * the vault fails that backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline void SetMinRetentionDays(long long value) { m_minRetentionDaysHasBeenSet = true; m_minRetentionDays = value; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the minimum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to retain certain data
     * for at least seven years (2555 days).</p> <p>If this parameter is not specified,
     * Vault Lock will not enforce a minimum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or longer than the minimum retention period. If
     * the job's retention period is shorter than that minimum retention period, then
     * the vault fails that backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithMinRetentionDays(long long value) { SetMinRetentionDays(value); return *this;}


    /**
     * <p>The Backup Vault Lock configuration that specifies the maximum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to destroy certain
     * data after retaining it for four years (1460 days).</p> <p>If this parameter is
     * not included, Vault Lock does not enforce a maximum retention period on the
     * recovery points in the vault. If this parameter is included without a value,
     * Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or shorter than the maximum retention period.
     * If the job's retention period is longer than that maximum retention period, then
     * the vault fails the backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline long long GetMaxRetentionDays() const{ return m_maxRetentionDays; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the maximum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to destroy certain
     * data after retaining it for four years (1460 days).</p> <p>If this parameter is
     * not included, Vault Lock does not enforce a maximum retention period on the
     * recovery points in the vault. If this parameter is included without a value,
     * Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or shorter than the maximum retention period.
     * If the job's retention period is longer than that maximum retention period, then
     * the vault fails the backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline bool MaxRetentionDaysHasBeenSet() const { return m_maxRetentionDaysHasBeenSet; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the maximum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to destroy certain
     * data after retaining it for four years (1460 days).</p> <p>If this parameter is
     * not included, Vault Lock does not enforce a maximum retention period on the
     * recovery points in the vault. If this parameter is included without a value,
     * Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or shorter than the maximum retention period.
     * If the job's retention period is longer than that maximum retention period, then
     * the vault fails the backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline void SetMaxRetentionDays(long long value) { m_maxRetentionDaysHasBeenSet = true; m_maxRetentionDays = value; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the maximum retention
     * period that the vault retains its recovery points. This setting can be useful
     * if, for example, your organization's policies require you to destroy certain
     * data after retaining it for four years (1460 days).</p> <p>If this parameter is
     * not included, Vault Lock does not enforce a maximum retention period on the
     * recovery points in the vault. If this parameter is included without a value,
     * Vault Lock will not enforce a maximum retention period.</p> <p>If this parameter
     * is specified, any backup or copy job to the vault must have a lifecycle policy
     * with a retention period equal to or shorter than the maximum retention period.
     * If the job's retention period is longer than that maximum retention period, then
     * the vault fails the backup or copy job, and you should either modify your
     * lifecycle settings or use a different vault. Recovery points already saved in
     * the vault prior to Vault Lock are not affected.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithMaxRetentionDays(long long value) { SetMaxRetentionDays(value); return *this;}


    /**
     * <p>The Backup Vault Lock configuration that specifies the number of days before
     * the lock date. For example, setting <code>ChangeableForDays</code> to 30 on Jan.
     * 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</p>
     * <p>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
     * and becomes immutable. Therefore, you must set <code>ChangeableForDays</code> to
     * 3 or greater.</p> <p>Before the lock date, you can delete Vault Lock from the
     * vault using <code>DeleteBackupVaultLockConfiguration</code> or change the Vault
     * Lock configuration using <code>PutBackupVaultLockConfiguration</code>. On and
     * after the lock date, the Vault Lock becomes immutable and cannot be changed or
     * deleted.</p> <p>If this parameter is not specified, you can delete Vault Lock
     * from the vault using <code>DeleteBackupVaultLockConfiguration</code> or change
     * the Vault Lock configuration using <code>PutBackupVaultLockConfiguration</code>
     * at any time.</p>
     */
    inline long long GetChangeableForDays() const{ return m_changeableForDays; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the number of days before
     * the lock date. For example, setting <code>ChangeableForDays</code> to 30 on Jan.
     * 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</p>
     * <p>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
     * and becomes immutable. Therefore, you must set <code>ChangeableForDays</code> to
     * 3 or greater.</p> <p>Before the lock date, you can delete Vault Lock from the
     * vault using <code>DeleteBackupVaultLockConfiguration</code> or change the Vault
     * Lock configuration using <code>PutBackupVaultLockConfiguration</code>. On and
     * after the lock date, the Vault Lock becomes immutable and cannot be changed or
     * deleted.</p> <p>If this parameter is not specified, you can delete Vault Lock
     * from the vault using <code>DeleteBackupVaultLockConfiguration</code> or change
     * the Vault Lock configuration using <code>PutBackupVaultLockConfiguration</code>
     * at any time.</p>
     */
    inline bool ChangeableForDaysHasBeenSet() const { return m_changeableForDaysHasBeenSet; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the number of days before
     * the lock date. For example, setting <code>ChangeableForDays</code> to 30 on Jan.
     * 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</p>
     * <p>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
     * and becomes immutable. Therefore, you must set <code>ChangeableForDays</code> to
     * 3 or greater.</p> <p>Before the lock date, you can delete Vault Lock from the
     * vault using <code>DeleteBackupVaultLockConfiguration</code> or change the Vault
     * Lock configuration using <code>PutBackupVaultLockConfiguration</code>. On and
     * after the lock date, the Vault Lock becomes immutable and cannot be changed or
     * deleted.</p> <p>If this parameter is not specified, you can delete Vault Lock
     * from the vault using <code>DeleteBackupVaultLockConfiguration</code> or change
     * the Vault Lock configuration using <code>PutBackupVaultLockConfiguration</code>
     * at any time.</p>
     */
    inline void SetChangeableForDays(long long value) { m_changeableForDaysHasBeenSet = true; m_changeableForDays = value; }

    /**
     * <p>The Backup Vault Lock configuration that specifies the number of days before
     * the lock date. For example, setting <code>ChangeableForDays</code> to 30 on Jan.
     * 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</p>
     * <p>Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
     * and becomes immutable. Therefore, you must set <code>ChangeableForDays</code> to
     * 3 or greater.</p> <p>Before the lock date, you can delete Vault Lock from the
     * vault using <code>DeleteBackupVaultLockConfiguration</code> or change the Vault
     * Lock configuration using <code>PutBackupVaultLockConfiguration</code>. On and
     * after the lock date, the Vault Lock becomes immutable and cannot be changed or
     * deleted.</p> <p>If this parameter is not specified, you can delete Vault Lock
     * from the vault using <code>DeleteBackupVaultLockConfiguration</code> or change
     * the Vault Lock configuration using <code>PutBackupVaultLockConfiguration</code>
     * at any time.</p>
     */
    inline PutBackupVaultLockConfigurationRequest& WithChangeableForDays(long long value) { SetChangeableForDays(value); return *this;}

  private:

    Aws::String m_backupVaultName;
    bool m_backupVaultNameHasBeenSet;

    long long m_minRetentionDays;
    bool m_minRetentionDaysHasBeenSet;

    long long m_maxRetentionDays;
    bool m_maxRetentionDaysHasBeenSet;

    long long m_changeableForDays;
    bool m_changeableForDaysHasBeenSet;
  };

} // namespace Model
} // namespace Backup
} // namespace Aws