DBProxyEndpoint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rds.model.DBProxyEndpoint

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DBProxyEndpoint
extends Object
implements Serializable, Cloneable
```
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 Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBProxyEndpoint()

Constructors
Constructor and Description
`DBProxyEndpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DBProxyEndpoint`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()` The date and time when the DB proxy endpoint was first created.
`String`	`getDBProxyEndpointArn()` The Amazon Resource Name (ARN) for the DB proxy endpoint.
`String`	`getDBProxyEndpointName()` The name for the DB proxy endpoint.
`String`	`getDBProxyName()` The identifier for the DB proxy that is associated with this DB proxy endpoint.
`String`	`getEndpoint()` The endpoint that you can use to connect to the DB proxy.
`Boolean`	`getIsDefault()` A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
`String`	`getStatus()` The current status of this DB proxy endpoint.
`String`	`getTargetRole()` A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
`String`	`getVpcId()` Provides the VPC ID of the DB proxy endpoint.
`List<String>`	`getVpcSecurityGroupIds()` Provides a list of VPC security groups that the DB proxy endpoint belongs to.
`List<String>`	`getVpcSubnetIds()` The EC2 subnet IDs for the DB proxy endpoint.
`int`	`hashCode()`
`Boolean`	`isDefault()` A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
`void`	`setCreatedDate(Date createdDate)` The date and time when the DB proxy endpoint was first created.
`void`	`setDBProxyEndpointArn(String dBProxyEndpointArn)` The Amazon Resource Name (ARN) for the DB proxy endpoint.
`void`	`setDBProxyEndpointName(String dBProxyEndpointName)` The name for the DB proxy endpoint.
`void`	`setDBProxyName(String dBProxyName)` The identifier for the DB proxy that is associated with this DB proxy endpoint.
`void`	`setEndpoint(String endpoint)` The endpoint that you can use to connect to the DB proxy.
`void`	`setIsDefault(Boolean isDefault)` A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
`void`	`setStatus(String status)` The current status of this DB proxy endpoint.
`void`	`setTargetRole(String targetRole)` A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
`void`	`setVpcId(String vpcId)` Provides the VPC ID of the DB proxy endpoint.
`void`	`setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` Provides a list of VPC security groups that the DB proxy endpoint belongs to.
`void`	`setVpcSubnetIds(Collection<String> vpcSubnetIds)` The EC2 subnet IDs for the DB proxy endpoint.
`String`	`toString()` Returns a string representation of this object.
`DBProxyEndpoint`	`withCreatedDate(Date createdDate)` The date and time when the DB proxy endpoint was first created.
`DBProxyEndpoint`	`withDBProxyEndpointArn(String dBProxyEndpointArn)` The Amazon Resource Name (ARN) for the DB proxy endpoint.
`DBProxyEndpoint`	`withDBProxyEndpointName(String dBProxyEndpointName)` The name for the DB proxy endpoint.
`DBProxyEndpoint`	`withDBProxyName(String dBProxyName)` The identifier for the DB proxy that is associated with this DB proxy endpoint.
`DBProxyEndpoint`	`withEndpoint(String endpoint)` The endpoint that you can use to connect to the DB proxy.
`DBProxyEndpoint`	`withIsDefault(Boolean isDefault)` A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
`DBProxyEndpoint`	`withStatus(DBProxyEndpointStatus status)` The current status of this DB proxy endpoint.
`DBProxyEndpoint`	`withStatus(String status)` The current status of this DB proxy endpoint.
`DBProxyEndpoint`	`withTargetRole(DBProxyEndpointTargetRole targetRole)` A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
`DBProxyEndpoint`	`withTargetRole(String targetRole)` A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
`DBProxyEndpoint`	`withVpcId(String vpcId)` Provides the VPC ID of the DB proxy endpoint.
`DBProxyEndpoint`	`withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` Provides a list of VPC security groups that the DB proxy endpoint belongs to.
`DBProxyEndpoint`	`withVpcSecurityGroupIds(String... vpcSecurityGroupIds)` Provides a list of VPC security groups that the DB proxy endpoint belongs to.
`DBProxyEndpoint`	`withVpcSubnetIds(Collection<String> vpcSubnetIds)` The EC2 subnet IDs for the DB proxy endpoint.
`DBProxyEndpoint`	`withVpcSubnetIds(String... vpcSubnetIds)` The EC2 subnet IDs for the DB proxy endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DBProxyEndpoint
```
public DBProxyEndpoint()
```
- Method Detail
  - setDBProxyEndpointName
```
public void setDBProxyEndpointName(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.
    
    Parameters:
    
    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.
  - getDBProxyEndpointName
```
public String getDBProxyEndpointName()
```
    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.
  - withDBProxyEndpointName
```
public DBProxyEndpoint withDBProxyEndpointName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBProxyEndpointArn
```
public void setDBProxyEndpointArn(String dBProxyEndpointArn)
```
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    
    Parameters:
    
    dBProxyEndpointArn - The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - getDBProxyEndpointArn
```
public String getDBProxyEndpointArn()
```
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
  - withDBProxyEndpointArn
```
public DBProxyEndpoint withDBProxyEndpointArn(String dBProxyEndpointArn)
```
    The Amazon Resource Name (ARN) for the DB proxy endpoint.
    
    Parameters:
    
    dBProxyEndpointArn - The Amazon Resource Name (ARN) for the DB proxy endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBProxyName
```
public void setDBProxyName(String dBProxyName)
```
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
    
    Parameters:
    
    dBProxyName - The identifier for the DB proxy that is associated with this DB proxy endpoint.
  - getDBProxyName
```
public String getDBProxyName()
```
    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.
  - withDBProxyName
```
public DBProxyEndpoint withDBProxyName(String dBProxyName)
```
    The identifier for the DB proxy that is associated with this DB proxy endpoint.
    
    Parameters:
    
    dBProxyName - The identifier for the DB proxy that is associated with this DB proxy endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    DBProxyEndpointStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    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
  - withStatus
```
public DBProxyEndpoint withStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DBProxyEndpointStatus
  - withStatus
```
public DBProxyEndpoint withStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DBProxyEndpointStatus
  - setVpcId
```
public void setVpcId(String vpcId)
```
    Provides the VPC ID of the DB proxy endpoint.
    
    Parameters:
    
    vpcId - Provides the VPC ID of the DB proxy endpoint.
  - getVpcId
```
public String getVpcId()
```
    Provides the VPC ID of the DB proxy endpoint.
    
    Returns:
    
    Provides the VPC ID of the DB proxy endpoint.
  - withVpcId
```
public DBProxyEndpoint withVpcId(String vpcId)
```
    Provides the VPC ID of the DB proxy endpoint.
    
    Parameters:
    
    vpcId - Provides the VPC ID of the DB proxy endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSecurityGroupIds
```
public List<String> getVpcSecurityGroupIds()
```
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    Returns:
    
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    Parameters:
    
    vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.
  - withVpcSecurityGroupIds
```
public DBProxyEndpoint withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSecurityGroupIds(java.util.Collection) or withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroupIds
```
public DBProxyEndpoint withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    Parameters:
    
    vpcSecurityGroupIds - Provides a list of VPC security groups that the DB proxy endpoint belongs to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVpcSubnetIds
```
public List<String> getVpcSubnetIds()
```
    The EC2 subnet IDs for the DB proxy endpoint.
    
    Returns:
    
    The EC2 subnet IDs for the DB proxy endpoint.
  - setVpcSubnetIds
```
public void setVpcSubnetIds(Collection<String> vpcSubnetIds)
```
    The EC2 subnet IDs for the DB proxy endpoint.
    
    Parameters:
    
    vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.
  - withVpcSubnetIds
```
public DBProxyEndpoint withVpcSubnetIds(String... vpcSubnetIds)
```
    The EC2 subnet IDs for the DB proxy endpoint.
    
    NOTE: This method appends the values to the existing list (if any). Use setVpcSubnetIds(java.util.Collection) or withVpcSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSubnetIds
```
public DBProxyEndpoint withVpcSubnetIds(Collection<String> vpcSubnetIds)
```
    The EC2 subnet IDs for the DB proxy endpoint.
    
    Parameters:
    
    vpcSubnetIds - The EC2 subnet IDs for the DB proxy endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(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.
    
    Parameters:
    
    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.
  - getEndpoint
```
public String getEndpoint()
```
    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.
  - withEndpoint
```
public DBProxyEndpoint withEndpoint(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date and time when the DB proxy endpoint was first created.
    
    Parameters:
    
    createdDate - The date and time when the DB proxy endpoint was first created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    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.
  - withCreatedDate
```
public DBProxyEndpoint withCreatedDate(Date createdDate)
```
    The date and time when the DB proxy endpoint was first created.
    
    Parameters:
    
    createdDate - The date and time when the DB proxy endpoint was first created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetRole
```
public void setTargetRole(String targetRole)
```
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Parameters:
    
    targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    See Also:
    
    DBProxyEndpointTargetRole
  - getTargetRole
```
public String getTargetRole()
```
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Returns:
    
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    See Also:
    
    DBProxyEndpointTargetRole
  - withTargetRole
```
public DBProxyEndpoint withTargetRole(String targetRole)
```
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Parameters:
    
    targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DBProxyEndpointTargetRole
  - withTargetRole
```
public DBProxyEndpoint withTargetRole(DBProxyEndpointTargetRole targetRole)
```
    A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Parameters:
    
    targetRole - A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DBProxyEndpointTargetRole
  - setIsDefault
```
public void setIsDefault(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.
    
    Parameters:
    
    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.
  - getIsDefault
```
public Boolean getIsDefault()
```
    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.
  - withIsDefault
```
public DBProxyEndpoint withIsDefault(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefault
```
public 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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DBProxyEndpoint clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DBProxyEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DBProxyEndpoint

Method Detail

setDBProxyEndpointName

getDBProxyEndpointName

withDBProxyEndpointName

setDBProxyEndpointArn

getDBProxyEndpointArn

withDBProxyEndpointArn

setDBProxyName

getDBProxyName

withDBProxyName

setStatus

getStatus

withStatus

withStatus

setVpcId

getVpcId

withVpcId

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

getVpcSubnetIds

setVpcSubnetIds

withVpcSubnetIds

withVpcSubnetIds

setEndpoint

getEndpoint

withEndpoint

setCreatedDate

getCreatedDate

withCreatedDate

setTargetRole

getTargetRole

withTargetRole

withTargetRole

setIsDefault

getIsDefault

withIsDefault

isDefault

toString

equals

hashCode

clone