/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace DocDBElastic { namespace Model { /** *

Returns information about a specific Elastic DocumentDB * cluster.

See Also:

AWS * API Reference

*/ class Cluster { public: AWS_DOCDBELASTIC_API Cluster(); AWS_DOCDBELASTIC_API Cluster(Aws::Utils::Json::JsonView jsonValue); AWS_DOCDBELASTIC_API Cluster& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_DOCDBELASTIC_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline const Aws::String& GetAdminUserName() const{ return m_adminUserName; } /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline bool AdminUserNameHasBeenSet() const { return m_adminUserNameHasBeenSet; } /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline void SetAdminUserName(const Aws::String& value) { m_adminUserNameHasBeenSet = true; m_adminUserName = value; } /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline void SetAdminUserName(Aws::String&& value) { m_adminUserNameHasBeenSet = true; m_adminUserName = std::move(value); } /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline void SetAdminUserName(const char* value) { m_adminUserNameHasBeenSet = true; m_adminUserName.assign(value); } /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline Cluster& WithAdminUserName(const Aws::String& value) { SetAdminUserName(value); return *this;} /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline Cluster& WithAdminUserName(Aws::String&& value) { SetAdminUserName(std::move(value)); return *this;} /** *

The name of the Elastic DocumentDB cluster administrator.

*/ inline Cluster& WithAdminUserName(const char* value) { SetAdminUserName(value); return *this;} /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline const Auth& GetAuthType() const{ return m_authType; } /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline bool AuthTypeHasBeenSet() const { return m_authTypeHasBeenSet; } /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline void SetAuthType(const Auth& value) { m_authTypeHasBeenSet = true; m_authType = value; } /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline void SetAuthType(Auth&& value) { m_authTypeHasBeenSet = true; m_authType = std::move(value); } /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline Cluster& WithAuthType(const Auth& value) { SetAuthType(value); return *this;} /** *

The authentication type for the Elastic DocumentDB cluster.

*/ inline Cluster& WithAuthType(Auth&& value) { SetAuthType(std::move(value)); return *this;} /** *

The arn of the Elastic DocumentDB cluster.

*/ inline const Aws::String& GetClusterArn() const{ return m_clusterArn; } /** *

The arn of the Elastic DocumentDB cluster.

*/ inline bool ClusterArnHasBeenSet() const { return m_clusterArnHasBeenSet; } /** *

The arn of the Elastic DocumentDB cluster.

*/ inline void SetClusterArn(const Aws::String& value) { m_clusterArnHasBeenSet = true; m_clusterArn = value; } /** *

The arn of the Elastic DocumentDB cluster.

*/ inline void SetClusterArn(Aws::String&& value) { m_clusterArnHasBeenSet = true; m_clusterArn = std::move(value); } /** *

The arn of the Elastic DocumentDB cluster.

*/ inline void SetClusterArn(const char* value) { m_clusterArnHasBeenSet = true; m_clusterArn.assign(value); } /** *

The arn of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterArn(const Aws::String& value) { SetClusterArn(value); return *this;} /** *

The arn of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterArn(Aws::String&& value) { SetClusterArn(std::move(value)); return *this;} /** *

The arn of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterArn(const char* value) { SetClusterArn(value); return *this;} /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline const Aws::String& GetClusterEndpoint() const{ return m_clusterEndpoint; } /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline bool ClusterEndpointHasBeenSet() const { return m_clusterEndpointHasBeenSet; } /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline void SetClusterEndpoint(const Aws::String& value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint = value; } /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline void SetClusterEndpoint(Aws::String&& value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint = std::move(value); } /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline void SetClusterEndpoint(const char* value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint.assign(value); } /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterEndpoint(const Aws::String& value) { SetClusterEndpoint(value); return *this;} /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterEndpoint(Aws::String&& value) { SetClusterEndpoint(std::move(value)); return *this;} /** *

The URL used to connect to the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterEndpoint(const char* value) { SetClusterEndpoint(value); return *this;} /** *

The name of the Elastic DocumentDB cluster.

*/ inline const Aws::String& GetClusterName() const{ return m_clusterName; } /** *

The name of the Elastic DocumentDB cluster.

*/ inline bool ClusterNameHasBeenSet() const { return m_clusterNameHasBeenSet; } /** *

The name of the Elastic DocumentDB cluster.

*/ inline void SetClusterName(const Aws::String& value) { m_clusterNameHasBeenSet = true; m_clusterName = value; } /** *

The name of the Elastic DocumentDB cluster.

*/ inline void SetClusterName(Aws::String&& value) { m_clusterNameHasBeenSet = true; m_clusterName = std::move(value); } /** *

The name of the Elastic DocumentDB cluster.

*/ inline void SetClusterName(const char* value) { m_clusterNameHasBeenSet = true; m_clusterName.assign(value); } /** *

The name of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterName(const Aws::String& value) { SetClusterName(value); return *this;} /** *

The name of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterName(Aws::String&& value) { SetClusterName(std::move(value)); return *this;} /** *

The name of the Elastic DocumentDB cluster.

*/ inline Cluster& WithClusterName(const char* value) { SetClusterName(value); return *this;} /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline const Aws::String& GetCreateTime() const{ return m_createTime; } /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline bool CreateTimeHasBeenSet() const { return m_createTimeHasBeenSet; } /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline void SetCreateTime(const Aws::String& value) { m_createTimeHasBeenSet = true; m_createTime = value; } /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline void SetCreateTime(Aws::String&& value) { m_createTimeHasBeenSet = true; m_createTime = std::move(value); } /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline void SetCreateTime(const char* value) { m_createTimeHasBeenSet = true; m_createTime.assign(value); } /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline Cluster& WithCreateTime(const Aws::String& value) { SetCreateTime(value); return *this;} /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline Cluster& WithCreateTime(Aws::String&& value) { SetCreateTime(std::move(value)); return *this;} /** *

The time when the Elastic DocumentDB cluster was created in Universal * Coordinated Time (UTC).

*/ inline Cluster& WithCreateTime(const char* value) { SetCreateTime(value); return *this;} /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline Cluster& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline Cluster& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

*/ inline Cluster& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline const Aws::String& GetPreferredMaintenanceWindow() const{ return m_preferredMaintenanceWindow; } /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline bool PreferredMaintenanceWindowHasBeenSet() const { return m_preferredMaintenanceWindowHasBeenSet; } /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline void SetPreferredMaintenanceWindow(const Aws::String& value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow = value; } /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline void SetPreferredMaintenanceWindow(Aws::String&& value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow = std::move(value); } /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline void SetPreferredMaintenanceWindow(const char* value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow.assign(value); } /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline Cluster& WithPreferredMaintenanceWindow(const Aws::String& value) { SetPreferredMaintenanceWindow(value); return *this;} /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline Cluster& WithPreferredMaintenanceWindow(Aws::String&& value) { SetPreferredMaintenanceWindow(std::move(value)); return *this;} /** *

The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).

Format: * ddd:hh24:mi-ddd:hh24:mi

*/ inline Cluster& WithPreferredMaintenanceWindow(const char* value) { SetPreferredMaintenanceWindow(value); return *this;} /** *

The capacity of each shard in the Elastic DocumentDB cluster.

*/ inline int GetShardCapacity() const{ return m_shardCapacity; } /** *

The capacity of each shard in the Elastic DocumentDB cluster.

*/ inline bool ShardCapacityHasBeenSet() const { return m_shardCapacityHasBeenSet; } /** *

The capacity of each shard in the Elastic DocumentDB cluster.

*/ inline void SetShardCapacity(int value) { m_shardCapacityHasBeenSet = true; m_shardCapacity = value; } /** *

The capacity of each shard in the Elastic DocumentDB cluster.

*/ inline Cluster& WithShardCapacity(int value) { SetShardCapacity(value); return *this;} /** *

The number of shards in the Elastic DocumentDB cluster.

*/ inline int GetShardCount() const{ return m_shardCount; } /** *

The number of shards in the Elastic DocumentDB cluster.

*/ inline bool ShardCountHasBeenSet() const { return m_shardCountHasBeenSet; } /** *

The number of shards in the Elastic DocumentDB cluster.

*/ inline void SetShardCount(int value) { m_shardCountHasBeenSet = true; m_shardCount = value; } /** *

The number of shards in the Elastic DocumentDB cluster.

*/ inline Cluster& WithShardCount(int value) { SetShardCount(value); return *this;} /** *

The status of the Elastic DocumentDB cluster.

*/ inline const Status& GetStatus() const{ return m_status; } /** *

The status of the Elastic DocumentDB cluster.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the Elastic DocumentDB cluster.

*/ inline void SetStatus(const Status& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the Elastic DocumentDB cluster.

*/ inline void SetStatus(Status&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the Elastic DocumentDB cluster.

*/ inline Cluster& WithStatus(const Status& value) { SetStatus(value); return *this;} /** *

The status of the Elastic DocumentDB cluster.

*/ inline Cluster& WithStatus(Status&& value) { SetStatus(std::move(value)); return *this;} /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline const Aws::Vector& GetSubnetIds() const{ return m_subnetIds; } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline bool SubnetIdsHasBeenSet() const { return m_subnetIdsHasBeenSet; } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline void SetSubnetIds(const Aws::Vector& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = value; } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline void SetSubnetIds(Aws::Vector&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds = std::move(value); } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline Cluster& WithSubnetIds(const Aws::Vector& value) { SetSubnetIds(value); return *this;} /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline Cluster& WithSubnetIds(Aws::Vector&& value) { SetSubnetIds(std::move(value)); return *this;} /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline Cluster& AddSubnetIds(const Aws::String& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline Cluster& AddSubnetIds(Aws::String&& value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(std::move(value)); return *this; } /** *

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

*/ inline Cluster& AddSubnetIds(const char* value) { m_subnetIdsHasBeenSet = true; m_subnetIds.push_back(value); return *this; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline const Aws::Vector& GetVpcSecurityGroupIds() const{ return m_vpcSecurityGroupIds; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline bool VpcSecurityGroupIdsHasBeenSet() const { return m_vpcSecurityGroupIdsHasBeenSet; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline void SetVpcSecurityGroupIds(const Aws::Vector& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds = value; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline void SetVpcSecurityGroupIds(Aws::Vector&& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds = std::move(value); } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline Cluster& WithVpcSecurityGroupIds(const Aws::Vector& value) { SetVpcSecurityGroupIds(value); return *this;} /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline Cluster& WithVpcSecurityGroupIds(Aws::Vector&& value) { SetVpcSecurityGroupIds(std::move(value)); return *this;} /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline Cluster& AddVpcSecurityGroupIds(const Aws::String& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline Cluster& AddVpcSecurityGroupIds(Aws::String&& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(std::move(value)); return *this; } /** *

A list of EC2 VPC security groups associated with this cluster.

*/ inline Cluster& AddVpcSecurityGroupIds(const char* value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } private: Aws::String m_adminUserName; bool m_adminUserNameHasBeenSet = false; Auth m_authType; bool m_authTypeHasBeenSet = false; Aws::String m_clusterArn; bool m_clusterArnHasBeenSet = false; Aws::String m_clusterEndpoint; bool m_clusterEndpointHasBeenSet = false; Aws::String m_clusterName; bool m_clusterNameHasBeenSet = false; Aws::String m_createTime; bool m_createTimeHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; Aws::String m_preferredMaintenanceWindow; bool m_preferredMaintenanceWindowHasBeenSet = false; int m_shardCapacity; bool m_shardCapacityHasBeenSet = false; int m_shardCount; bool m_shardCountHasBeenSet = false; Status m_status; bool m_statusHasBeenSet = false; Aws::Vector m_subnetIds; bool m_subnetIdsHasBeenSet = false; Aws::Vector m_vpcSecurityGroupIds; bool m_vpcSecurityGroupIdsHasBeenSet = false; }; } // namespace Model } // namespace DocDBElastic } // namespace Aws