software.amazon.awssdk.services.rds.model

Class CreateDbClusterEndpointResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rds.model.RdsResponse

software.amazon.awssdk.services.rds.model.CreateDbClusterEndpointResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDbClusterEndpointResponse.Builder,CreateDbClusterEndpointResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDbClusterEndpointResponse
extends RdsResponse
implements ToCopyableBuilder<CreateDbClusterEndpointResponse.Builder,CreateDbClusterEndpointResponse>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDbClusterEndpointResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDbClusterEndpointResponse.Builder	builder()
String	customEndpointType() The type associated with a custom endpoint.
String	dbClusterEndpointArn() The Amazon Resource Name (ARN) for the endpoint.
String	dbClusterEndpointIdentifier() The identifier associated with the endpoint.
String	dbClusterEndpointResourceIdentifier() A unique system-generated identifier for an endpoint.
String	dbClusterIdentifier() The DB cluster identifier of the DB cluster associated with the endpoint.
String	endpoint() The DNS address of the endpoint.
String	endpointType() The type of the endpoint.
boolean	equals(Object obj)
List<String>	excludedMembers() List of DB instance identifiers that aren't part of the custom endpoint group.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDbClusterEndpointResponse.Builder>	serializableBuilderClass()
List<String>	staticMembers() List of DB instance identifiers that are part of the custom endpoint group.
String	status() The current status of the endpoint.
CreateDbClusterEndpointResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.services.rds.model.RdsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbClusterEndpointIdentifier

public String dbClusterEndpointIdentifier()

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.

dbClusterIdentifier

public String dbClusterIdentifier()

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.

dbClusterEndpointResourceIdentifier

public String dbClusterEndpointResourceIdentifier()

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.

endpoint

public String endpoint()

The DNS address of the endpoint.

Returns:

The DNS address of the endpoint.

status

public String status()

The current status of the endpoint. One of: creating, available, deleting, modifying.

Returns:

The current status of the endpoint. One of: creating, available, deleting, modifying.

endpointType

public String endpointType()

The type of the endpoint. One of: READER, WRITER, CUSTOM.

Returns:

The type of the endpoint. One of: READER, WRITER, CUSTOM.

customEndpointType

public String customEndpointType()

The type associated with a custom endpoint. One of: READER, ANY.

Returns:

The type associated with a custom endpoint. One of: READER, ANY.

staticMembers

public List<String> staticMembers()

List of DB instance identifiers that are part of the custom endpoint group.

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

Returns:

List of DB instance identifiers that are part of the custom endpoint group.

excludedMembers

public List<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.

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

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.

dbClusterEndpointArn

public String dbClusterEndpointArn()

The Amazon Resource Name (ARN) for the endpoint.

Returns:

The Amazon Resource Name (ARN) for the endpoint.

toBuilder

public CreateDbClusterEndpointResponse.Builder 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 interface ToCopyableBuilder<CreateDbClusterEndpointResponse.Builder,CreateDbClusterEndpointResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateDbClusterEndpointResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.