ClusterEngineBindOptions

class aws_cdk.aws_rds.ClusterEngineBindOptions(*, parameter_group=None, s3_export_role=None, s3_import_role=None)

Bases: object

The extra options passed to the {@link IClusterEngine.bindToCluster} method.

Parameters
  • parameter_group (Optional[IParameterGroup]) – The customer-provided ParameterGroup. Default: - none

  • s3_export_role (Optional[IRole]) – The role used for S3 exporting. Default: - none

  • s3_import_role (Optional[IRole]) – The role used for S3 importing. Default: - none

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iam as iam
import aws_cdk.aws_rds as rds

# parameter_group: rds.ParameterGroup
# role: iam.Role

cluster_engine_bind_options = rds.ClusterEngineBindOptions(
    parameter_group=parameter_group,
    s3_export_role=role,
    s3_import_role=role
)

Attributes

parameter_group

The customer-provided ParameterGroup.

Default
  • none

Return type

Optional[IParameterGroup]

s3_export_role

The role used for S3 exporting.

Default
  • none

Return type

Optional[IRole]

s3_import_role

The role used for S3 importing.

Default
  • none

Return type

Optional[IRole]