382 lines
18 KiB
C++
382 lines
18 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/dynamodb/DynamoDB_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/dynamodb/model/ReplicaStatus.h>
|
|
#include <aws/dynamodb/model/BillingModeSummary.h>
|
|
#include <aws/dynamodb/model/AutoScalingSettingsDescription.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/dynamodb/model/ReplicaGlobalSecondaryIndexSettingsDescription.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace DynamoDB
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Represents the properties of a replica.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ReplicaSettingsDescription">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_DYNAMODB_API ReplicaSettingsDescription
|
|
{
|
|
public:
|
|
ReplicaSettingsDescription();
|
|
ReplicaSettingsDescription(Aws::Utils::Json::JsonView jsonValue);
|
|
ReplicaSettingsDescription& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline const Aws::String& GetRegionName() const{ return m_regionName; }
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline bool RegionNameHasBeenSet() const { return m_regionNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline void SetRegionName(const Aws::String& value) { m_regionNameHasBeenSet = true; m_regionName = value; }
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline void SetRegionName(Aws::String&& value) { m_regionNameHasBeenSet = true; m_regionName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline void SetRegionName(const char* value) { m_regionNameHasBeenSet = true; m_regionName.assign(value); }
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithRegionName(const Aws::String& value) { SetRegionName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithRegionName(Aws::String&& value) { SetRegionName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The Region name of the replica.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithRegionName(const char* value) { SetRegionName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline const ReplicaStatus& GetReplicaStatus() const{ return m_replicaStatus; }
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline bool ReplicaStatusHasBeenSet() const { return m_replicaStatusHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline void SetReplicaStatus(const ReplicaStatus& value) { m_replicaStatusHasBeenSet = true; m_replicaStatus = value; }
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline void SetReplicaStatus(ReplicaStatus&& value) { m_replicaStatusHasBeenSet = true; m_replicaStatus = std::move(value); }
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaStatus(const ReplicaStatus& value) { SetReplicaStatus(value); return *this;}
|
|
|
|
/**
|
|
* <p>The current state of the Region:</p> <ul> <li> <p> <code>CREATING</code> -
|
|
* The Region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The
|
|
* Region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The Region
|
|
* is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The Region is ready
|
|
* for use.</p> </li> </ul>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaStatus(ReplicaStatus&& value) { SetReplicaStatus(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline const BillingModeSummary& GetReplicaBillingModeSummary() const{ return m_replicaBillingModeSummary; }
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline bool ReplicaBillingModeSummaryHasBeenSet() const { return m_replicaBillingModeSummaryHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline void SetReplicaBillingModeSummary(const BillingModeSummary& value) { m_replicaBillingModeSummaryHasBeenSet = true; m_replicaBillingModeSummary = value; }
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline void SetReplicaBillingModeSummary(BillingModeSummary&& value) { m_replicaBillingModeSummaryHasBeenSet = true; m_replicaBillingModeSummary = std::move(value); }
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaBillingModeSummary(const BillingModeSummary& value) { SetReplicaBillingModeSummary(value); return *this;}
|
|
|
|
/**
|
|
* <p>The read/write capacity mode of the replica.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaBillingModeSummary(BillingModeSummary&& value) { SetReplicaBillingModeSummary(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of strongly consistent reads consumed per second before
|
|
* DynamoDB returns a <code>ThrottlingException</code>. For more information, see
|
|
* <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.
|
|
* </p>
|
|
*/
|
|
inline long long GetReplicaProvisionedReadCapacityUnits() const{ return m_replicaProvisionedReadCapacityUnits; }
|
|
|
|
/**
|
|
* <p>The maximum number of strongly consistent reads consumed per second before
|
|
* DynamoDB returns a <code>ThrottlingException</code>. For more information, see
|
|
* <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.
|
|
* </p>
|
|
*/
|
|
inline bool ReplicaProvisionedReadCapacityUnitsHasBeenSet() const { return m_replicaProvisionedReadCapacityUnitsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of strongly consistent reads consumed per second before
|
|
* DynamoDB returns a <code>ThrottlingException</code>. For more information, see
|
|
* <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.
|
|
* </p>
|
|
*/
|
|
inline void SetReplicaProvisionedReadCapacityUnits(long long value) { m_replicaProvisionedReadCapacityUnitsHasBeenSet = true; m_replicaProvisionedReadCapacityUnits = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of strongly consistent reads consumed per second before
|
|
* DynamoDB returns a <code>ThrottlingException</code>. For more information, see
|
|
* <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.
|
|
* </p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedReadCapacityUnits(long long value) { SetReplicaProvisionedReadCapacityUnits(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline const AutoScalingSettingsDescription& GetReplicaProvisionedReadCapacityAutoScalingSettings() const{ return m_replicaProvisionedReadCapacityAutoScalingSettings; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline bool ReplicaProvisionedReadCapacityAutoScalingSettingsHasBeenSet() const { return m_replicaProvisionedReadCapacityAutoScalingSettingsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline void SetReplicaProvisionedReadCapacityAutoScalingSettings(const AutoScalingSettingsDescription& value) { m_replicaProvisionedReadCapacityAutoScalingSettingsHasBeenSet = true; m_replicaProvisionedReadCapacityAutoScalingSettings = value; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline void SetReplicaProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription&& value) { m_replicaProvisionedReadCapacityAutoScalingSettingsHasBeenSet = true; m_replicaProvisionedReadCapacityAutoScalingSettings = std::move(value); }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedReadCapacityAutoScalingSettings(const AutoScalingSettingsDescription& value) { SetReplicaProvisionedReadCapacityAutoScalingSettings(value); return *this;}
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription&& value) { SetReplicaProvisionedReadCapacityAutoScalingSettings(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
* <code>ThrottlingException</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline long long GetReplicaProvisionedWriteCapacityUnits() const{ return m_replicaProvisionedWriteCapacityUnits; }
|
|
|
|
/**
|
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
* <code>ThrottlingException</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline bool ReplicaProvisionedWriteCapacityUnitsHasBeenSet() const { return m_replicaProvisionedWriteCapacityUnitsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
* <code>ThrottlingException</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline void SetReplicaProvisionedWriteCapacityUnits(long long value) { m_replicaProvisionedWriteCapacityUnitsHasBeenSet = true; m_replicaProvisionedWriteCapacityUnits = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
* <code>ThrottlingException</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying
|
|
* Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedWriteCapacityUnits(long long value) { SetReplicaProvisionedWriteCapacityUnits(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline const AutoScalingSettingsDescription& GetReplicaProvisionedWriteCapacityAutoScalingSettings() const{ return m_replicaProvisionedWriteCapacityAutoScalingSettings; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline bool ReplicaProvisionedWriteCapacityAutoScalingSettingsHasBeenSet() const { return m_replicaProvisionedWriteCapacityAutoScalingSettingsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline void SetReplicaProvisionedWriteCapacityAutoScalingSettings(const AutoScalingSettingsDescription& value) { m_replicaProvisionedWriteCapacityAutoScalingSettingsHasBeenSet = true; m_replicaProvisionedWriteCapacityAutoScalingSettings = value; }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline void SetReplicaProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription&& value) { m_replicaProvisionedWriteCapacityAutoScalingSettingsHasBeenSet = true; m_replicaProvisionedWriteCapacityAutoScalingSettings = std::move(value); }
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedWriteCapacityAutoScalingSettings(const AutoScalingSettingsDescription& value) { SetReplicaProvisionedWriteCapacityAutoScalingSettings(value); return *this;}
|
|
|
|
/**
|
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription&& value) { SetReplicaProvisionedWriteCapacityAutoScalingSettings(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline const Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription>& GetReplicaGlobalSecondaryIndexSettings() const{ return m_replicaGlobalSecondaryIndexSettings; }
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline bool ReplicaGlobalSecondaryIndexSettingsHasBeenSet() const { return m_replicaGlobalSecondaryIndexSettingsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline void SetReplicaGlobalSecondaryIndexSettings(const Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription>& value) { m_replicaGlobalSecondaryIndexSettingsHasBeenSet = true; m_replicaGlobalSecondaryIndexSettings = value; }
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline void SetReplicaGlobalSecondaryIndexSettings(Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription>&& value) { m_replicaGlobalSecondaryIndexSettingsHasBeenSet = true; m_replicaGlobalSecondaryIndexSettings = std::move(value); }
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaGlobalSecondaryIndexSettings(const Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription>& value) { SetReplicaGlobalSecondaryIndexSettings(value); return *this;}
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& WithReplicaGlobalSecondaryIndexSettings(Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription>&& value) { SetReplicaGlobalSecondaryIndexSettings(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& AddReplicaGlobalSecondaryIndexSettings(const ReplicaGlobalSecondaryIndexSettingsDescription& value) { m_replicaGlobalSecondaryIndexSettingsHasBeenSet = true; m_replicaGlobalSecondaryIndexSettings.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
*/
|
|
inline ReplicaSettingsDescription& AddReplicaGlobalSecondaryIndexSettings(ReplicaGlobalSecondaryIndexSettingsDescription&& value) { m_replicaGlobalSecondaryIndexSettingsHasBeenSet = true; m_replicaGlobalSecondaryIndexSettings.push_back(std::move(value)); return *this; }
|
|
|
|
private:
|
|
|
|
Aws::String m_regionName;
|
|
bool m_regionNameHasBeenSet;
|
|
|
|
ReplicaStatus m_replicaStatus;
|
|
bool m_replicaStatusHasBeenSet;
|
|
|
|
BillingModeSummary m_replicaBillingModeSummary;
|
|
bool m_replicaBillingModeSummaryHasBeenSet;
|
|
|
|
long long m_replicaProvisionedReadCapacityUnits;
|
|
bool m_replicaProvisionedReadCapacityUnitsHasBeenSet;
|
|
|
|
AutoScalingSettingsDescription m_replicaProvisionedReadCapacityAutoScalingSettings;
|
|
bool m_replicaProvisionedReadCapacityAutoScalingSettingsHasBeenSet;
|
|
|
|
long long m_replicaProvisionedWriteCapacityUnits;
|
|
bool m_replicaProvisionedWriteCapacityUnitsHasBeenSet;
|
|
|
|
AutoScalingSettingsDescription m_replicaProvisionedWriteCapacityAutoScalingSettings;
|
|
bool m_replicaProvisionedWriteCapacityAutoScalingSettingsHasBeenSet;
|
|
|
|
Aws::Vector<ReplicaGlobalSecondaryIndexSettingsDescription> m_replicaGlobalSecondaryIndexSettings;
|
|
bool m_replicaGlobalSecondaryIndexSettingsHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace DynamoDB
|
|
} // namespace Aws
|