Skip to content
v2.277.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rds as rds
from aws_cdk.interfaces import aws_iam as interfaces_iam

# option_group: rds.OptionGroup
# role_ref: interfaces_iam.IRoleRef

instance_engine_bind_options = rds.InstanceEngineBindOptions(
    domain="domain",
    option_group=option_group,
    s3_export_role=role_ref,
    s3_import_role=role_ref,
    timezone="timezone"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;
import software.amazon.awscdk.interfaces.iam.*;

OptionGroup optionGroup;
IRoleRef roleRef;

InstanceEngineBindOptions instanceEngineBindOptions = InstanceEngineBindOptions.builder()
        .domain("domain")
        .optionGroup(optionGroup)
        .s3ExportRole(roleRef)
        .s3ImportRole(roleRef)
        .timezone("timezone")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
using Amazon.CDK.Interfaces.IAM;

OptionGroup optionGroup;
IRoleRef roleRef;

var instanceEngineBindOptions = new InstanceEngineBindOptions {
    Domain = "domain",
    OptionGroup = optionGroup,
    S3ExportRole = roleRef,
    S3ImportRole = roleRef,
    Timezone = "timezone"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var optionGroup OptionGroup
var roleRef IRoleRef

instanceEngineBindOptions := &InstanceEngineBindOptions{
	Domain: jsii.String("domain"),
	OptionGroup: optionGroup,
	S3ExportRole: roleRef,
	S3ImportRole: roleRef,
	Timezone: jsii.String("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)