Skip to content

RDS  >  Operations  >  register_db_proxy_targets

register_db_proxy_targets

Operation

register_db_proxy_targets async

register_db_proxy_targets(request: RegisterDBProxyTargetsInput | RegisterDBProxyTargetsInputDict, /, *, plugins: list[Plugin] | None = None) -> RegisterDBProxyTargetsOutput
register_db_proxy_targets(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterDBProxyTargetsInputDict]) -> RegisterDBProxyTargetsOutput

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

Parameters:

Name Type Description Default
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
RegisterDBProxyTargetsOutput

An instance of RegisterDBProxyTargetsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

RegisterDBProxyTargetsInput dataclass

Bases: _SerdeShape

Dataclass for RegisterDBProxyTargetsInput structure.

Attributes
db_cluster_identifiers class-attribute instance-attribute
db_cluster_identifiers: list[str] | None = ...

One or more DB cluster identifiers.

db_instance_identifiers class-attribute instance-attribute
db_instance_identifiers: list[str] | None = ...

One or more DB instance identifiers.

db_proxy_name class-attribute instance-attribute
db_proxy_name: str | None = ...

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

target_group_name class-attribute instance-attribute
target_group_name: str | None = ...

The identifier of the DBProxyTargetGroup.

Dictionaries

RegisterDBProxyTargetsInputDict

Bases: TypedDict

Dictionary form of RegisterDBProxyTargetsInput.

Attributes
db_cluster_identifiers instance-attribute
db_cluster_identifiers: Sequence[str] | None

One or more DB cluster identifiers.

db_instance_identifiers instance-attribute
db_instance_identifiers: Sequence[str] | None

One or more DB instance identifiers.

db_proxy_name instance-attribute
db_proxy_name: Required[str]

The identifier of the DBProxy that is associated with the DBProxyTargetGroup.

target_group_name instance-attribute
target_group_name: str | None

The identifier of the DBProxyTargetGroup.

Output

RegisterDBProxyTargetsOutput dataclass

Bases: _SerdeShape

Dataclass for RegisterDBProxyTargetsOutput structure.

Attributes

db_proxy_targets class-attribute instance-attribute
db_proxy_targets: list[DBProxyTarget] | None = ...

One or more DBProxyTarget objects that are created when you register targets with a target group.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.