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

The data structure representing an endpoint associated with a DB proxy. RDS * automatically creates one endpoint for each DB proxy. For Aurora DB clusters, * you can associate additional endpoints with the same DB proxy. These endpoints * can be read/write or read-only. They can also reside in different VPCs than the * associated DB proxy.

This data type is used as a response element in the * DescribeDBProxyEndpoints operation.

See Also:

AWS * API Reference

*/ class DBProxyEndpoint { public: AWS_RDS_API DBProxyEndpoint(); AWS_RDS_API DBProxyEndpoint(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_RDS_API DBProxyEndpoint& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_RDS_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_RDS_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline const Aws::String& GetDBProxyEndpointName() const{ return m_dBProxyEndpointName; } /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline bool DBProxyEndpointNameHasBeenSet() const { return m_dBProxyEndpointNameHasBeenSet; } /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline void SetDBProxyEndpointName(const Aws::String& value) { m_dBProxyEndpointNameHasBeenSet = true; m_dBProxyEndpointName = value; } /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline void SetDBProxyEndpointName(Aws::String&& value) { m_dBProxyEndpointNameHasBeenSet = true; m_dBProxyEndpointName = std::move(value); } /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline void SetDBProxyEndpointName(const char* value) { m_dBProxyEndpointNameHasBeenSet = true; m_dBProxyEndpointName.assign(value); } /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline DBProxyEndpoint& WithDBProxyEndpointName(const Aws::String& value) { SetDBProxyEndpointName(value); return *this;} /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline DBProxyEndpoint& WithDBProxyEndpointName(Aws::String&& value) { SetDBProxyEndpointName(std::move(value)); return *this;} /** *

The name for the DB proxy endpoint. An identifier must begin with a letter * and must contain only ASCII letters, digits, and hyphens; it can't end with a * hyphen or contain two consecutive hyphens.

*/ inline DBProxyEndpoint& WithDBProxyEndpointName(const char* value) { SetDBProxyEndpointName(value); return *this;} /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline const Aws::String& GetDBProxyEndpointArn() const{ return m_dBProxyEndpointArn; } /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline bool DBProxyEndpointArnHasBeenSet() const { return m_dBProxyEndpointArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline void SetDBProxyEndpointArn(const Aws::String& value) { m_dBProxyEndpointArnHasBeenSet = true; m_dBProxyEndpointArn = value; } /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline void SetDBProxyEndpointArn(Aws::String&& value) { m_dBProxyEndpointArnHasBeenSet = true; m_dBProxyEndpointArn = std::move(value); } /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline void SetDBProxyEndpointArn(const char* value) { m_dBProxyEndpointArnHasBeenSet = true; m_dBProxyEndpointArn.assign(value); } /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithDBProxyEndpointArn(const Aws::String& value) { SetDBProxyEndpointArn(value); return *this;} /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithDBProxyEndpointArn(Aws::String&& value) { SetDBProxyEndpointArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) for the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithDBProxyEndpointArn(const char* value) { SetDBProxyEndpointArn(value); return *this;} /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline const Aws::String& GetDBProxyName() const{ return m_dBProxyName; } /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline bool DBProxyNameHasBeenSet() const { return m_dBProxyNameHasBeenSet; } /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline void SetDBProxyName(const Aws::String& value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName = value; } /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline void SetDBProxyName(Aws::String&& value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName = std::move(value); } /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline void SetDBProxyName(const char* value) { m_dBProxyNameHasBeenSet = true; m_dBProxyName.assign(value); } /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline DBProxyEndpoint& WithDBProxyName(const Aws::String& value) { SetDBProxyName(value); return *this;} /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline DBProxyEndpoint& WithDBProxyName(Aws::String&& value) { SetDBProxyName(std::move(value)); return *this;} /** *

The identifier for the DB proxy that is associated with this DB proxy * endpoint.

*/ inline DBProxyEndpoint& WithDBProxyName(const char* value) { SetDBProxyName(value); return *this;} /** *

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

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

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

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

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

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

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

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

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

*/ inline DBProxyEndpoint& WithStatus(const DBProxyEndpointStatus& value) { SetStatus(value); return *this;} /** *

The current status of this DB proxy endpoint. A status of * available means the endpoint is ready to handle requests. Other * values indicate that you must wait for the endpoint to be ready, or take some * action to resolve an issue.

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

Provides the VPC ID of the DB proxy endpoint.

*/ inline const Aws::String& GetVpcId() const{ return m_vpcId; } /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline bool VpcIdHasBeenSet() const { return m_vpcIdHasBeenSet; } /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline void SetVpcId(const Aws::String& value) { m_vpcIdHasBeenSet = true; m_vpcId = value; } /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline void SetVpcId(Aws::String&& value) { m_vpcIdHasBeenSet = true; m_vpcId = std::move(value); } /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline void SetVpcId(const char* value) { m_vpcIdHasBeenSet = true; m_vpcId.assign(value); } /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithVpcId(const Aws::String& value) { SetVpcId(value); return *this;} /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithVpcId(Aws::String&& value) { SetVpcId(std::move(value)); return *this;} /** *

Provides the VPC ID of the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithVpcId(const char* value) { SetVpcId(value); return *this;} /** *

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

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

Provides a list of VPC security groups that the DB proxy endpoint belongs * to.

*/ inline DBProxyEndpoint& AddVpcSecurityGroupIds(const char* value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline const Aws::Vector& GetVpcSubnetIds() const{ return m_vpcSubnetIds; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline bool VpcSubnetIdsHasBeenSet() const { return m_vpcSubnetIdsHasBeenSet; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline void SetVpcSubnetIds(const Aws::Vector& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds = value; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline void SetVpcSubnetIds(Aws::Vector&& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds = std::move(value); } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithVpcSubnetIds(const Aws::Vector& value) { SetVpcSubnetIds(value); return *this;} /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline DBProxyEndpoint& WithVpcSubnetIds(Aws::Vector&& value) { SetVpcSubnetIds(std::move(value)); return *this;} /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline DBProxyEndpoint& AddVpcSubnetIds(const Aws::String& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(value); return *this; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline DBProxyEndpoint& AddVpcSubnetIds(Aws::String&& value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(std::move(value)); return *this; } /** *

The EC2 subnet IDs for the DB proxy endpoint.

*/ inline DBProxyEndpoint& AddVpcSubnetIds(const char* value) { m_vpcSubnetIdsHasBeenSet = true; m_vpcSubnetIds.push_back(value); return *this; } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline const Aws::String& GetEndpoint() const{ return m_endpoint; } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline bool EndpointHasBeenSet() const { return m_endpointHasBeenSet; } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline void SetEndpoint(const Aws::String& value) { m_endpointHasBeenSet = true; m_endpoint = value; } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline void SetEndpoint(Aws::String&& value) { m_endpointHasBeenSet = true; m_endpoint = std::move(value); } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline void SetEndpoint(const char* value) { m_endpointHasBeenSet = true; m_endpoint.assign(value); } /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline DBProxyEndpoint& WithEndpoint(const Aws::String& value) { SetEndpoint(value); return *this;} /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline DBProxyEndpoint& WithEndpoint(Aws::String&& value) { SetEndpoint(std::move(value)); return *this;} /** *

The endpoint that you can use to connect to the DB proxy. You include the * endpoint value in the connection string for a database client application.

*/ inline DBProxyEndpoint& WithEndpoint(const char* value) { SetEndpoint(value); return *this;} /** *

The date and time when the DB proxy endpoint was first created.

*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *

The date and time when the DB proxy endpoint was first created.

*/ inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; } /** *

The date and time when the DB proxy endpoint was first created.

*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDateHasBeenSet = true; m_createdDate = value; } /** *

The date and time when the DB proxy endpoint was first created.

*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::move(value); } /** *

The date and time when the DB proxy endpoint was first created.

*/ inline DBProxyEndpoint& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *

The date and time when the DB proxy endpoint was first created.

*/ inline DBProxyEndpoint& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline const DBProxyEndpointTargetRole& GetTargetRole() const{ return m_targetRole; } /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline bool TargetRoleHasBeenSet() const { return m_targetRoleHasBeenSet; } /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline void SetTargetRole(const DBProxyEndpointTargetRole& value) { m_targetRoleHasBeenSet = true; m_targetRole = value; } /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline void SetTargetRole(DBProxyEndpointTargetRole&& value) { m_targetRoleHasBeenSet = true; m_targetRole = std::move(value); } /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline DBProxyEndpoint& WithTargetRole(const DBProxyEndpointTargetRole& value) { SetTargetRole(value); return *this;} /** *

A value that indicates whether the DB proxy endpoint can be used for * read/write or read-only operations.

*/ inline DBProxyEndpoint& WithTargetRole(DBProxyEndpointTargetRole&& value) { SetTargetRole(std::move(value)); return *this;} /** *

A value that indicates whether this endpoint is the default endpoint for the * associated DB proxy. Default DB proxy endpoints always have read/write * capability. Other endpoints that you associate with the DB proxy can be either * read/write or read-only.

*/ inline bool GetIsDefault() const{ return m_isDefault; } /** *

A value that indicates whether this endpoint is the default endpoint for the * associated DB proxy. Default DB proxy endpoints always have read/write * capability. Other endpoints that you associate with the DB proxy can be either * read/write or read-only.

*/ inline bool IsDefaultHasBeenSet() const { return m_isDefaultHasBeenSet; } /** *

A value that indicates whether this endpoint is the default endpoint for the * associated DB proxy. Default DB proxy endpoints always have read/write * capability. Other endpoints that you associate with the DB proxy can be either * read/write or read-only.

*/ inline void SetIsDefault(bool value) { m_isDefaultHasBeenSet = true; m_isDefault = value; } /** *

A value that indicates whether this endpoint is the default endpoint for the * associated DB proxy. Default DB proxy endpoints always have read/write * capability. Other endpoints that you associate with the DB proxy can be either * read/write or read-only.

*/ inline DBProxyEndpoint& WithIsDefault(bool value) { SetIsDefault(value); return *this;} private: Aws::String m_dBProxyEndpointName; bool m_dBProxyEndpointNameHasBeenSet = false; Aws::String m_dBProxyEndpointArn; bool m_dBProxyEndpointArnHasBeenSet = false; Aws::String m_dBProxyName; bool m_dBProxyNameHasBeenSet = false; DBProxyEndpointStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_vpcId; bool m_vpcIdHasBeenSet = false; Aws::Vector m_vpcSecurityGroupIds; bool m_vpcSecurityGroupIdsHasBeenSet = false; Aws::Vector m_vpcSubnetIds; bool m_vpcSubnetIdsHasBeenSet = false; Aws::String m_endpoint; bool m_endpointHasBeenSet = false; Aws::Utils::DateTime m_createdDate; bool m_createdDateHasBeenSet = false; DBProxyEndpointTargetRole m_targetRole; bool m_targetRoleHasBeenSet = false; bool m_isDefault; bool m_isDefaultHasBeenSet = false; }; } // namespace Model } // namespace RDS } // namespace Aws