software.amazon.awssdk.services.rds.model

Class DBProxyEndpoint

java.lang.Object

software.amazon.awssdk.services.rds.model.DBProxyEndpoint

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>

@Generated(value="software.amazon.awssdk:codegen")
public final class DBProxyEndpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DBProxyEndpoint.Builder

Method Summary

Modifier and Type	Method and Description
static DBProxyEndpoint.Builder	builder()
Instant	createdDate() The date and time when the DB proxy endpoint was first created.
String	dbProxyEndpointArn() The Amazon Resource Name (ARN) for the DB proxy endpoint.
String	dbProxyEndpointName() The name for the DB proxy endpoint.
String	dbProxyName() The identifier for the DB proxy that is associated with this DB proxy endpoint.
String	endpoint() The endpoint that you can use to connect to the DB proxy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVpcSecurityGroupIds() For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
boolean	hasVpcSubnetIds() For responses, this returns true if the service returned a value for the VpcSubnetIds property.
Boolean	isDefault() A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
List<SdkField<?>>	sdkFields()
static Class<? extends DBProxyEndpoint.Builder>	serializableBuilderClass()
DBProxyEndpointStatus	status() The current status of this DB proxy endpoint.
String	statusAsString() The current status of this DB proxy endpoint.
DBProxyEndpointTargetRole	targetRole() A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
String	targetRoleAsString() A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
DBProxyEndpoint.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() Provides the VPC ID of the DB proxy endpoint.
List<String>	vpcSecurityGroupIds() Provides a list of VPC security groups that the DB proxy endpoint belongs to.
List<String>	vpcSubnetIds() The EC2 subnet IDs for the DB proxy endpoint.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

dbProxyEndpointName

public final String 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.

Returns:

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.

dbProxyEndpointArn

public final String dbProxyEndpointArn()

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

Returns:

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

dbProxyName

public final String dbProxyName()

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

Returns:

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

status

public final DBProxyEndpointStatus 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.

If the service returns an enum value that is not available in the current SDK version, status will return DBProxyEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

DBProxyEndpointStatus

statusAsString

public final String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return DBProxyEndpointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

DBProxyEndpointStatus

vpcId

public final String vpcId()

Provides the VPC ID of the DB proxy endpoint.

Returns:

Provides the VPC ID of the DB proxy endpoint.

hasVpcSecurityGroupIds

public final boolean hasVpcSecurityGroupIds()

For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSecurityGroupIds

public final List<String> vpcSecurityGroupIds()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

Returns:

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

hasVpcSubnetIds

public final boolean hasVpcSubnetIds()

For responses, this returns true if the service returned a value for the VpcSubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

vpcSubnetIds

public final List<String> vpcSubnetIds()

The EC2 subnet IDs for the DB proxy endpoint.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSubnetIds() method.

Returns:

The EC2 subnet IDs for the DB proxy endpoint.

endpoint

public final String 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.

Returns:

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.

createdDate

public final Instant createdDate()

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

Returns:

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

targetRole

public final DBProxyEndpointTargetRole targetRole()

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

If the service returns an enum value that is not available in the current SDK version, targetRole will return DBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetRoleAsString().

Returns:

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

See Also:

DBProxyEndpointTargetRole

targetRoleAsString

public final String targetRoleAsString()

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

If the service returns an enum value that is not available in the current SDK version, targetRole will return DBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetRoleAsString().

Returns:

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

See Also:

DBProxyEndpointTargetRole

isDefault

public final Boolean 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.

Returns:

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.

toBuilder

public DBProxyEndpoint.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DBProxyEndpoint.Builder,DBProxyEndpoint>

builder

public static DBProxyEndpoint.Builder builder()

serializableBuilderClass

public static Class<? extends DBProxyEndpoint.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo