Skip to content

RDS  >  Operations  >  add_role_to_db_cluster

add_role_to_db_cluster

Operation

add_role_to_db_cluster async

add_role_to_db_cluster(request: AddRoleToDBClusterInput | AddRoleToDBClusterInputDict, /, *, plugins: list[Plugin] | None = None) -> AddRoleToDBClusterOutput
add_role_to_db_cluster(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AddRoleToDBClusterInputDict]) -> AddRoleToDBClusterOutput

Associates an Identity and Access Management (IAM) role with a DB cluster.

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
AddRoleToDBClusterOutput

An instance of AddRoleToDBClusterOutput.

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

AddRoleToDBClusterInput dataclass

Bases: _SerdeShape

Dataclass for AddRoleToDBClusterInput structure.

Attributes
db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

The name of the DB cluster to associate the IAM role with.

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

The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

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

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

Dictionaries

AddRoleToDBClusterInputDict

Bases: TypedDict

Dictionary form of AddRoleToDBClusterInput.

Attributes
db_cluster_identifier instance-attribute
db_cluster_identifier: Required[str]

The name of the DB cluster to associate the IAM role with.

feature_name instance-attribute
feature_name: str | None

The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.

role_arn instance-attribute
role_arn: Required[str]

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

Output

AddRoleToDBClusterOutput dataclass

Bases: _SerdeShape

Dataclass for AddRoleToDBClusterOutput structure.

Attributes

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.