Struct aws_sdk_rds::types::DbProxyEndpoint

#[non_exhaustive]
pub struct DbProxyEndpoint {
    pub db_proxy_endpoint_name: Option<String>,
    pub db_proxy_endpoint_arn: Option<String>,
    pub db_proxy_name: Option<String>,
    pub status: Option<DbProxyEndpointStatus>,
    pub vpc_id: Option<String>,
    pub vpc_security_group_ids: Option<Vec<String>>,
    pub vpc_subnet_ids: Option<Vec<String>>,
    pub endpoint: Option<String>,
    pub created_date: Option<DateTime>,
    pub target_role: Option<DbProxyEndpointTargetRole>,
    pub is_default: Option<bool>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_proxy_endpoint_name: Option<String>

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.

db_proxy_endpoint_arn: Option<String>

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

db_proxy_name: Option<String>

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

status: Option<DbProxyEndpointStatus>

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.

vpc_id: Option<String>

Provides the VPC ID of the DB proxy endpoint.

vpc_security_group_ids: Option<Vec<String>>

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

vpc_subnet_ids: Option<Vec<String>>

The EC2 subnet IDs for the DB proxy endpoint.

endpoint: Option<String>

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.

created_date: Option<DateTime>

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

target_role: Option<DbProxyEndpointTargetRole>

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

is_default: Option<bool>

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.

Implementations

impl DbProxyEndpoint

pub fn db_proxy_endpoint_name(&self) -> Option<&str>

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.

pub fn db_proxy_endpoint_arn(&self) -> Option<&str>

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

pub fn db_proxy_name(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&DbProxyEndpointStatus>

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.

pub fn vpc_id(&self) -> Option<&str>

Provides the VPC ID of the DB proxy endpoint.

pub fn vpc_security_group_ids(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_group_ids.is_none().

pub fn vpc_subnet_ids(&self) -> &[String]

The EC2 subnet IDs for the DB proxy endpoint.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_subnet_ids.is_none().

pub fn endpoint(&self) -> Option<&str>

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.

pub fn created_date(&self) -> Option<&DateTime>

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

pub fn target_role(&self) -> Option<&DbProxyEndpointTargetRole>

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

pub fn is_default(&self) -> Option<bool>

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.

impl DbProxyEndpoint

pub fn builder() -> DbProxyEndpointBuilder

Creates a new builder-style object to manufacture DbProxyEndpoint.

Trait Implementations

impl Clone for DbProxyEndpoint

fn clone(&self) -> DbProxyEndpoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DbProxyEndpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DbProxyEndpoint

fn eq(&self, other: &DbProxyEndpoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DbProxyEndpoint