Class: AWSCDK::RDS::InstanceEngineBindOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/instance_engine_bind_options.rb

Overview

The options passed to IInstanceEngine.bind.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain: nil, option_group: nil, s3_export_role: nil, s3_import_role: nil, timezone: nil) ⇒ InstanceEngineBindOptions

Returns a new instance of InstanceEngineBindOptions.

Parameters:

  • domain (String, nil) (defaults to: nil) —

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

  • option_group (AWSCDK::RDS::IOptionGroup, nil) (defaults to: nil) —

    The option group of the database.

  • s3_export_role (AWSCDK::Interfaces::AWSIAM::IRoleRef, nil) (defaults to: nil) —

    The role used for S3 exporting.

  • s3_import_role (AWSCDK::Interfaces::AWSIAM::IRoleRef, nil) (defaults to: nil) —

    The role used for S3 importing.

  • timezone (String, nil) (defaults to: nil) —

    The timezone of the database, set by the customer.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'rds/instance_engine_bind_options.rb', line 12

def initialize(domain: nil, option_group: nil, s3_export_role: nil, s3_import_role: nil, timezone: nil)
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil?
  @option_group = option_group
  Jsii::Type.check_type(@option_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLklPcHRpb25Hcm91cCJ9")), "optionGroup") unless @option_group.nil?
  @s3_export_role = s3_export_role
  Jsii::Type.check_type(@s3_export_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "s3ExportRole") unless @s3_export_role.nil?
  @s3_import_role = s3_import_role
  Jsii::Type.check_type(@s3_import_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "s3ImportRole") unless @s3_import_role.nil?
  @timezone = timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timezone") unless @timezone.nil?
end

Instance Attribute Details

#domain ⇒ String? (readonly)

Note:

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

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

Returns:

  • (String, nil) 


29
30
31
 
# File 'rds/instance_engine_bind_options.rb', line 29

def domain
  @domain
end

#option_group ⇒ AWSCDK::RDS::IOptionGroup? (readonly)

Note:

Default: - none

The option group of the database.

Returns:



34
35
36
 
# File 'rds/instance_engine_bind_options.rb', line 34

def option_group
  @option_group
end

#s3_export_role ⇒ AWSCDK::Interfaces::AWSIAM::IRoleRef? (readonly)

Note:

Default: - none

The role used for S3 exporting.

Returns:



39
40
41
 
# File 'rds/instance_engine_bind_options.rb', line 39

def s3_export_role
  @s3_export_role
end

#s3_import_role ⇒ AWSCDK::Interfaces::AWSIAM::IRoleRef? (readonly)

Note:

Default: - none

The role used for S3 importing.

Returns:



44
45
46
 
# File 'rds/instance_engine_bind_options.rb', line 44

def s3_import_role
  @s3_import_role
end

#timezone ⇒ String? (readonly)

Note:

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

The timezone of the database, set by the customer.

Returns:

  • (String, nil) 


49
50
51
 
# File 'rds/instance_engine_bind_options.rb', line 49

def timezone
  @timezone
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'rds/instance_engine_bind_options.rb', line 51

def self.jsii_properties
  {
    :domain => "domain",
    :option_group => "optionGroup",
    :s3_export_role => "s3ExportRole",
    :s3_import_role => "s3ImportRole",
    :timezone => "timezone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'rds/instance_engine_bind_options.rb', line 61

def to_jsii
  result = {}
  result.merge!({
    "domain" => @domain,
    "optionGroup" => @option_group,
    "s3ExportRole" => @s3_export_role,
    "s3ImportRole" => @s3_import_role,
    "timezone" => @timezone,
  })
  result.compact
end