Class DBProxyEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DBProxyEndpoint.Builder
builder()
final Instant
The date and time when the DB proxy endpoint was first created.final String
The Amazon Resource Name (ARN) for the DB proxy endpoint.final String
The name for the DB proxy endpoint.final String
The identifier for the DB proxy that is associated with this DB proxy endpoint.final String
endpoint()
The endpoint that you can use to connect to the DB proxy.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.final boolean
For responses, this returns true if the service returned a value for the VpcSubnetIds property.final Boolean
Indicates whether this endpoint is the default endpoint for the associated DB proxy.static Class
<? extends DBProxyEndpoint.Builder> final DBProxyEndpointStatus
status()
The current status of this DB proxy endpoint.final String
The current status of this DB proxy endpoint.A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.final String
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
vpcId()
Provides the VPC ID of the DB proxy endpoint.Provides a list of VPC security groups that the DB proxy endpoint belongs to.The EC2 subnet IDs for the DB proxy endpoint.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Resource Name (ARN) for the DB proxy endpoint.
- Returns:
- The Amazon Resource Name (ARN) for the DB proxy endpoint.
-
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
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 returnDBProxyEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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 returnDBProxyEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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
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 returnDBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetRoleAsString()
.- Returns:
- A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- See Also:
-
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 returnDBProxyEndpointTargetRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetRoleAsString()
.- Returns:
- A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
- See Also:
-
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.
- Returns:
- 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DBProxyEndpoint.Builder,
DBProxyEndpoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-