Package software.amazon.awscdk.services.rds

Interface InstanceEngineBindOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InstanceEngineBindOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:23.574Z")
@Stability(Stable)
public interface InstanceEngineBindOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.rds.*;
 OptionGroup optionGroup;
 Role role;
 InstanceEngineBindOptions instanceEngineBindOptions = InstanceEngineBindOptions.builder()
         .domain("domain")
         .optionGroup(optionGroup)
         .s3ExportRole(role)
         .s3ImportRole(role)
         .timezone("timezone")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	InstanceEngineBindOptions.Builder	A builder for InstanceEngineBindOptions
static final class	InstanceEngineBindOptions.Jsii$Proxy	An implementation for InstanceEngineBindOptions

Method Summary

Modifier and Type	Method	Description
static InstanceEngineBindOptions.Builder	builder()
default String	getDomain()	The Active Directory directory ID to create the DB instance in.
default IOptionGroup	getOptionGroup()	The option group of the database.
default IRole	getS3ExportRole()	The role used for S3 exporting.
default IRole	getS3ImportRole()	The role used for S3 importing.
default String	getTimezone()	The timezone of the database, set by the customer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomain

@Stability(Stable)
@Nullable
default String getDomain()

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

Default: - none (it's an optional field)

getOptionGroup

@Stability(Stable)
@Nullable
default IOptionGroup getOptionGroup()

The option group of the database.

Default: - none

getS3ExportRole

@Stability(Stable)
@Nullable
default IRole getS3ExportRole()

The role used for S3 exporting.

Default: - none

getS3ImportRole

@Stability(Stable)
@Nullable
default IRole getS3ImportRole()

The role used for S3 importing.

Default: - none

getTimezone

@Stability(Stable)
@Nullable
default String getTimezone()

The timezone of the database, set by the customer.

Default: - none (it's an optional field)

builder

@Stability(Stable)
static InstanceEngineBindOptions.Builder builder()

Returns:

a InstanceEngineBindOptions.Builder of InstanceEngineBindOptions