modify_db_cluster_endpoint¶
Operation¶
async
¶
modify_db_cluster_endpoint(input: ModifyDBClusterEndpointInput, plugins: list[Plugin] | None = None) -> ModifyDBClusterEndpointOutput
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
Note
This operation only applies to Aurora DB clusters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyDBClusterEndpointInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyDBClusterEndpointOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyDBClusterEndpointInput structure.
Attributes¶
class-attribute
instance-attribute
¶
db_cluster_endpoint_identifier: str | None = ...
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
class-attribute
instance-attribute
¶
endpoint_type: str | None = ...
The type of the endpoint. One of: READER, WRITER, ANY.
class-attribute
instance-attribute
¶
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.
Output¶
dataclass
¶
Bases: _SerdeShape
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.
Attributes¶
class-attribute
instance-attribute
¶
custom_endpoint_type: str | None = ...
The type associated with a custom endpoint. One of: READER, WRITER,
ANY.
class-attribute
instance-attribute
¶
db_cluster_endpoint_arn: str | None = ...
The Amazon Resource Name (ARN) for the endpoint.
class-attribute
instance-attribute
¶
db_cluster_endpoint_identifier: str | None = ...
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
class-attribute
instance-attribute
¶
db_cluster_endpoint_resource_identifier: str | None = ...
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
class-attribute
instance-attribute
¶
endpoint: str | None = ...
The DNS address of the endpoint.
class-attribute
instance-attribute
¶
endpoint_type: str | None = ...
The type of the endpoint. One of: READER, WRITER, CUSTOM.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
List of DB instance identifiers that are part of the custom endpoint group.
class-attribute
instance-attribute
¶
status: str | None = ...
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.