aws-cdk-lib.aws_rds.InstanceEngineBindOptions

interface InstanceEngineBindOptions

LanguageType name
.NETAmazon.CDK.AWS.RDS.InstanceEngineBindOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#InstanceEngineBindOptions
Javasoftware.amazon.awscdk.services.rds.InstanceEngineBindOptions
Pythonaws_cdk.aws_rds.InstanceEngineBindOptions
TypeScript (source)aws-cdk-lib » aws_rds » InstanceEngineBindOptions

The options passed to IInstanceEngine.bind.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_rds as rds } from 'aws-cdk-lib';

declare const optionGroup: rds.OptionGroup;
declare const role: iam.Role;
const instanceEngineBindOptions: rds.InstanceEngineBindOptions = {
  domain: 'domain',
  optionGroup: optionGroup,
  s3ExportRole: role,
  s3ImportRole: role,
  timezone: 'timezone',
};

Properties

NameTypeDescription
domain?stringThe Active Directory directory ID to create the DB instance in.
optionGroup?IOptionGroupThe option group of the database.
s3ExportRole?IRoleThe role used for S3 exporting.
s3ImportRole?IRoleThe role used for S3 importing.
timezone?stringThe timezone of the database, set by the customer.

domain?

Type: string (optional, default: none (it's an optional field))

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


optionGroup?

Type: IOptionGroup (optional, default: none)

The option group of the database.


s3ExportRole?

Type: IRole (optional, default: none)

The role used for S3 exporting.


s3ImportRole?

Type: IRole (optional, default: none)

The role used for S3 importing.


timezone?

Type: string (optional, default: none (it's an optional field))

The timezone of the database, set by the customer.