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)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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.
boolean	hasExcludedMembers() Returns true if the ExcludedMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasStaticMembers() Returns true if the StaticMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Returns a string representation of this object.

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 final 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 final 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 final 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 final String endpoint()

The DNS address of the endpoint.

Returns:

The DNS address of the endpoint.

status

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

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.

endpointType

public final 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 final String customEndpointType()

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.

hasStaticMembers

public final boolean hasStaticMembers()

Returns true if the StaticMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

staticMembers

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

You can use hasStaticMembers() to see if a value was sent in this field.

Returns:

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

hasExcludedMembers

public final boolean hasExcludedMembers()

Returns true if the ExcludedMembers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

excludedMembers

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

You can use hasExcludedMembers() to see if a value was sent in this field.

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 final 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 final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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