DBClusterEndpoint (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DBClusterEndpoint
extends Object
implements Serializable, Cloneable
```
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
- CreateDBClusterEndpoint
- DescribeDBClusterEndpoints
- ModifyDBClusterEndpoint
- DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DBClusterEndpoint()

Constructors
Constructor and Description
`DBClusterEndpoint()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DBClusterEndpoint`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomEndpointType()` The type associated with a custom endpoint.
`String`	`getDBClusterEndpointArn()` The Amazon Resource Name (ARN) for the endpoint.
`String`	`getDBClusterEndpointIdentifier()` The identifier associated with the endpoint.
`String`	`getDBClusterEndpointResourceIdentifier()` A unique system-generated identifier for an endpoint.
`String`	`getDBClusterIdentifier()` The DB cluster identifier of the DB cluster associated with the endpoint.
`String`	`getEndpoint()` The DNS address of the endpoint.
`String`	`getEndpointType()` The type of the endpoint.
`List<String>`	`getExcludedMembers()` List of DB instance identifiers that aren't part of the custom endpoint group.
`List<String>`	`getStaticMembers()` List of DB instance identifiers that are part of the custom endpoint group.
`String`	`getStatus()` The current status of the endpoint.
`int`	`hashCode()`
`void`	`setCustomEndpointType(String customEndpointType)` The type associated with a custom endpoint.
`void`	`setDBClusterEndpointArn(String dBClusterEndpointArn)` The Amazon Resource Name (ARN) for the endpoint.
`void`	`setDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier)` The identifier associated with the endpoint.
`void`	`setDBClusterEndpointResourceIdentifier(String dBClusterEndpointResourceIdentifier)` A unique system-generated identifier for an endpoint.
`void`	`setDBClusterIdentifier(String dBClusterIdentifier)` The DB cluster identifier of the DB cluster associated with the endpoint.
`void`	`setEndpoint(String endpoint)` The DNS address of the endpoint.
`void`	`setEndpointType(String endpointType)` The type of the endpoint.
`void`	`setExcludedMembers(Collection<String> excludedMembers)` List of DB instance identifiers that aren't part of the custom endpoint group.
`void`	`setStaticMembers(Collection<String> staticMembers)` List of DB instance identifiers that are part of the custom endpoint group.
`void`	`setStatus(String status)` The current status of the endpoint.
`String`	`toString()` Returns a string representation of this object.
`DBClusterEndpoint`	`withCustomEndpointType(String customEndpointType)` The type associated with a custom endpoint.
`DBClusterEndpoint`	`withDBClusterEndpointArn(String dBClusterEndpointArn)` The Amazon Resource Name (ARN) for the endpoint.
`DBClusterEndpoint`	`withDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier)` The identifier associated with the endpoint.
`DBClusterEndpoint`	`withDBClusterEndpointResourceIdentifier(String dBClusterEndpointResourceIdentifier)` A unique system-generated identifier for an endpoint.
`DBClusterEndpoint`	`withDBClusterIdentifier(String dBClusterIdentifier)` The DB cluster identifier of the DB cluster associated with the endpoint.
`DBClusterEndpoint`	`withEndpoint(String endpoint)` The DNS address of the endpoint.
`DBClusterEndpoint`	`withEndpointType(String endpointType)` The type of the endpoint.
`DBClusterEndpoint`	`withExcludedMembers(Collection<String> excludedMembers)` List of DB instance identifiers that aren't part of the custom endpoint group.
`DBClusterEndpoint`	`withExcludedMembers(String... excludedMembers)` List of DB instance identifiers that aren't part of the custom endpoint group.
`DBClusterEndpoint`	`withStaticMembers(Collection<String> staticMembers)` List of DB instance identifiers that are part of the custom endpoint group.
`DBClusterEndpoint`	`withStaticMembers(String... staticMembers)` List of DB instance identifiers that are part of the custom endpoint group.
`DBClusterEndpoint`	`withStatus(String status)` The current status of the endpoint.

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

- Constructor Detail
  - DBClusterEndpoint
```
public DBClusterEndpoint()
```
- Method Detail
  - setDBClusterEndpointIdentifier
```
public void setDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier)
```
    The identifier associated with the endpoint. This parameter is stored as a lowercase string.
    
    Parameters:
    
    dBClusterEndpointIdentifier - The identifier associated with the endpoint. This parameter is stored as a lowercase string.
  - getDBClusterEndpointIdentifier
```
public String getDBClusterEndpointIdentifier()
```
    The identifier associated with the endpoint. This parameter is stored as a lowercase string.
    
    Returns:
    
    The identifier associated with the endpoint. This parameter is stored as a lowercase string.
  - withDBClusterEndpointIdentifier
```
public DBClusterEndpoint withDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier)
```
    The identifier associated with the endpoint. This parameter is stored as a lowercase string.
    
    Parameters:
    
    dBClusterEndpointIdentifier - The identifier associated with the endpoint. This parameter is stored as a lowercase string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterIdentifier
```
public void setDBClusterIdentifier(String dBClusterIdentifier)
```
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    
    Parameters:
    
    dBClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
  - getDBClusterIdentifier
```
public String getDBClusterIdentifier()
```
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    
    Returns:
    
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
  - withDBClusterIdentifier
```
public DBClusterEndpoint withDBClusterIdentifier(String dBClusterIdentifier)
```
    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    
    Parameters:
    
    dBClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterEndpointResourceIdentifier
```
public void setDBClusterEndpointResourceIdentifier(String dBClusterEndpointResourceIdentifier)
```
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    
    Parameters:
    
    dBClusterEndpointResourceIdentifier - A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
  - getDBClusterEndpointResourceIdentifier
```
public String getDBClusterEndpointResourceIdentifier()
```
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    
    Returns:
    
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
  - withDBClusterEndpointResourceIdentifier
```
public DBClusterEndpoint withDBClusterEndpointResourceIdentifier(String dBClusterEndpointResourceIdentifier)
```
    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    
    Parameters:
    
    dBClusterEndpointResourceIdentifier - A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    The DNS address of the endpoint.
    
    Parameters:
    
    endpoint - The DNS address of the endpoint.
  - getEndpoint
```
public String getEndpoint()
```
    The DNS address of the endpoint.
    
    Returns:
    
    The DNS address of the endpoint.
  - withEndpoint
```
public DBClusterEndpoint withEndpoint(String endpoint)
```
    The DNS address of the endpoint.
    
    Parameters:
    
    endpoint - The DNS address of the 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 the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
    
    Parameters:
    
    status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
  - getStatus
```
public String getStatus()
```
    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
    
    Returns:
    
    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
  - withStatus
```
public DBClusterEndpoint withStatus(String status)
```
    The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
    
    Parameters:
    
    status - The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointType
```
public void setEndpointType(String endpointType)
```
    The type of the endpoint. One of: READER, WRITER, CUSTOM.
    
    Parameters:
    
    endpointType - The type of the endpoint. One of: READER, WRITER, CUSTOM.
  - getEndpointType
```
public String getEndpointType()
```
    The type of the endpoint. One of: READER, WRITER, CUSTOM.
    
    Returns:
    
    The type of the endpoint. One of: READER, WRITER, CUSTOM.
  - withEndpointType
```
public DBClusterEndpoint withEndpointType(String endpointType)
```
    The type of the endpoint. One of: READER, WRITER, CUSTOM.
    
    Parameters:
    
    endpointType - The type of the endpoint. One of: READER, WRITER, CUSTOM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomEndpointType
```
public void setCustomEndpointType(String customEndpointType)
```
    The type associated with a custom endpoint. One of: READER, WRITER, ANY.
    
    Parameters:
    
    customEndpointType - The type associated with a custom endpoint. One of: READER, WRITER, ANY.
  - getCustomEndpointType
```
public String getCustomEndpointType()
```
    The type associated with a custom endpoint. One of: READER, WRITER, ANY.
    
    Returns:
    
    The type associated with a custom endpoint. One of: READER, WRITER, ANY.
  - withCustomEndpointType
```
public DBClusterEndpoint withCustomEndpointType(String customEndpointType)
```
    The type associated with a custom endpoint. One of: READER, WRITER, ANY.
    
    Parameters:
    
    customEndpointType - The type associated with a custom endpoint. One of: READER, WRITER, ANY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStaticMembers
```
public List<String> getStaticMembers()
```
    List of DB instance identifiers that are part of the custom endpoint group.
    
    Returns:
    
    List of DB instance identifiers that are part of the custom endpoint group.
  - setStaticMembers
```
public void setStaticMembers(Collection<String> staticMembers)
```
    List of DB instance identifiers that are part of the custom endpoint group.
    
    Parameters:
    
    staticMembers - List of DB instance identifiers that are part of the custom endpoint group.
  - withStaticMembers
```
public DBClusterEndpoint withStaticMembers(String... staticMembers)
```
    List of DB instance identifiers that are part of the custom endpoint group.
    
    NOTE: This method appends the values to the existing list (if any). Use setStaticMembers(java.util.Collection) or withStaticMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    staticMembers - List of DB instance identifiers that are part of the custom endpoint group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStaticMembers
```
public DBClusterEndpoint withStaticMembers(Collection<String> staticMembers)
```
    List of DB instance identifiers that are part of the custom endpoint group.
    
    Parameters:
    
    staticMembers - List of DB instance identifiers that are part of the custom endpoint group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludedMembers
```
public List<String> getExcludedMembers()
```
    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    Returns:
    
    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
  - setExcludedMembers
```
public void setExcludedMembers(Collection<String> excludedMembers)
```
    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    Parameters:
    
    excludedMembers - List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
  - withExcludedMembers
```
public DBClusterEndpoint withExcludedMembers(String... excludedMembers)
```
    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludedMembers(java.util.Collection) or withExcludedMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludedMembers - List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludedMembers
```
public DBClusterEndpoint withExcludedMembers(Collection<String> excludedMembers)
```
    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    Parameters:
    
    excludedMembers - List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDBClusterEndpointArn
```
public void setDBClusterEndpointArn(String dBClusterEndpointArn)
```
    The Amazon Resource Name (ARN) for the endpoint.
    
    Parameters:
    
    dBClusterEndpointArn - The Amazon Resource Name (ARN) for the endpoint.
  - getDBClusterEndpointArn
```
public String getDBClusterEndpointArn()
```
    The Amazon Resource Name (ARN) for the endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the endpoint.
  - withDBClusterEndpointArn
```
public DBClusterEndpoint withDBClusterEndpointArn(String dBClusterEndpointArn)
```
    The Amazon Resource Name (ARN) for the endpoint.
    
    Parameters:
    
    dBClusterEndpointArn - The Amazon Resource Name (ARN) for the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 DBClusterEndpoint clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.777

Class DBClusterEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DBClusterEndpoint

Method Detail

setDBClusterEndpointIdentifier

getDBClusterEndpointIdentifier

withDBClusterEndpointIdentifier

setDBClusterIdentifier

getDBClusterIdentifier

withDBClusterIdentifier

setDBClusterEndpointResourceIdentifier

getDBClusterEndpointResourceIdentifier

withDBClusterEndpointResourceIdentifier

setEndpoint

getEndpoint

withEndpoint

setStatus

getStatus

withStatus

setEndpointType

getEndpointType

withEndpointType

setCustomEndpointType

getCustomEndpointType

withCustomEndpointType

getStaticMembers

setStaticMembers

withStaticMembers

withStaticMembers

getExcludedMembers

setExcludedMembers

withExcludedMembers

withExcludedMembers

setDBClusterEndpointArn

getDBClusterEndpointArn

withDBClusterEndpointArn

toString

equals

hashCode

clone