AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.RDS.Model.DBProxyEndpoint

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C# 
public class DBProxyEndpoint

The DBProxyEndpoint type exposes the following members

Constructors

NameDescription
Public Method DBProxyEndpoint()

Properties

NameTypeDescription
Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

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

Public Property DBProxyEndpointArn System.String

Gets and sets the property DBProxyEndpointArn.

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

Public Property DBProxyEndpointName System.String

Gets and sets the property 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.

Public Property DBProxyName System.String

Gets and sets the property DBProxyName.

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

Public Property Endpoint System.String

Gets and sets the property 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.

Public Property EndpointNetworkType Amazon.RDS.EndpointNetworkType

Gets and sets the property EndpointNetworkType.

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

  • IPV4 - The proxy endpoint supports IPv4 only.

  • IPV6 - The proxy endpoint supports IPv6 only.

  • DUAL - The proxy endpoint supports both IPv4 and IPv6.

Public Property IsDefault System.Boolean

Gets and sets the property IsDefault.

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.

Public Property Status Amazon.RDS.DBProxyEndpointStatus

Gets and sets the property 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.

Public Property TargetRole Amazon.RDS.DBProxyEndpointTargetRole

Gets and sets the property TargetRole.

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

Public Property VpcId System.String

Gets and sets the property VpcId.

Provides the VPC ID of the DB proxy endpoint.

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property VpcSecurityGroupIds.

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

Public Property VpcSubnetIds System.Collections.Generic.List<System.String>

Gets and sets the property VpcSubnetIds.

The EC2 subnet IDs for the DB proxy endpoint.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5