@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
.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDbClusterEndpointResponse.Builder |
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.
|
responseMetadata
sdkHttpResponse
copy
public final String dbClusterEndpointIdentifier()
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
public final String dbClusterIdentifier()
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
public final String dbClusterEndpointResourceIdentifier()
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
public final String endpoint()
The DNS address of the endpoint.
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.
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.public final String endpointType()
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
READER
, WRITER
, CUSTOM
.public final String customEndpointType()
The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
READER
, WRITER
,
ANY
.public final boolean hasStaticMembers()
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.
public final boolean hasExcludedMembers()
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.
public final String dbClusterEndpointArn()
The Amazon Resource Name (ARN) for the endpoint.
public CreateDbClusterEndpointResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDbClusterEndpointResponse.Builder,CreateDbClusterEndpointResponse>
toBuilder
in class AwsResponse
public static CreateDbClusterEndpointResponse.Builder builder()
public static Class<? extends CreateDbClusterEndpointResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.