Skip to content
v2.274.0

InstanceEngineBindOptions Struct ​

The options passed to IInstanceEngine.bind.

Example ​

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

declare const optionGroup: rds.OptionGroup;
declare const roleRef: interfaces_iam.IRoleRef;
const instanceEngineBindOptions: rds.InstanceEngineBindOptions = {
  domain: 'domain',
  optionGroup: optionGroup,
  s3ExportRole: roleRef,
  s3ImportRole: roleRef,
  timezone: 'timezone',
};

Properties ​

domainoptionalstringdomainoptionalstrdomainoptionalStringDomainoptionalstringDomainoptional*string#
The Active Directory directory ID to create the DB instance in.

Default: none (it's an optional field)

optionGroupoptionalIOptionGroupoption_groupoptionalIOptionGroupoptionGroupoptionalIOptionGroupOptionGroupoptionalIOptionGroupOptionGroupoptionalIOptionGroup= none#
The option group of the database.
s3ExportRoleoptionalIRoleRefs3_export_roleoptionalIRoleRefs3ExportRoleoptionalIRoleRefS3ExportRoleoptionalIRoleRefS3ExportRoleoptionalIRoleRef= none#
The role used for S3 exporting.
s3ImportRoleoptionalIRoleRefs3_import_roleoptionalIRoleRefs3ImportRoleoptionalIRoleRefS3ImportRoleoptionalIRoleRefS3ImportRoleoptionalIRoleRef= none#
The role used for S3 importing.
timezoneoptionalstringtimezoneoptionalstrtimezoneoptionalStringTimezoneoptionalstringTimezoneoptional*string#
The timezone of the database, set by the customer.

Default: none (it's an optional field)