InstanceEngineBindOptions

class aws_cdk.aws_rds.InstanceEngineBindOptions(*, domain=None, option_group=None, s3_export_role=None, s3_import_role=None, timezone=None)

Bases: object

The options passed to IInstanceEngine.bind.

Parameters:

  • domain (Optional[str]) – The Active Directory directory ID to create the DB instance in. Default: - none (it’s an optional field)

  • option_group (Optional[IOptionGroup]) – The option group of the database. 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

  • timezone (Optional[str]) – The timezone of the database, set by the customer. Default: - none (it’s an optional field)

ExampleMetadata:

fixture=_generated

Example:

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

# option_group: rds.OptionGroup
# role: iam.Role

instance_engine_bind_options = rds.InstanceEngineBindOptions(
    domain="domain",
    option_group=option_group,
    s3_export_role=role,
    s3_import_role=role,
    timezone="timezone"
)

Attributes

domain

The Active Directory directory ID to create the DB instance in.

Default:

  • none (it’s an optional field)

option_group

The option group of the database.

Default:

  • none

s3_export_role

The role used for S3 exporting.

Default:

  • none

s3_import_role

The role used for S3 importing.

Default:

  • none

timezone

The timezone of the database, set by the customer.

Default:

  • none (it’s an optional field)