Module: AWSCDK::RDS::IInstanceEngine

Includes:
IEngine
Defined in:
rds/i_instance_engine.rb

Overview

Interface representing a database instance (as opposed to cluster) engine.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'rds/i_instance_engine.rb', line 91

def self.jsii_overridable_methods
  {
    :engine_type => { kind: :property, name: "engineType", is_optional: false },
    :default_username => { kind: :property, name: "defaultUsername", is_optional: true },
    :engine_family => { kind: :property, name: "engineFamily", is_optional: true },
    :engine_version => { kind: :property, name: "engineVersion", is_optional: true },
    :parameter_group_family => { kind: :property, name: "parameterGroupFamily", is_optional: true },
    :multi_user_rotation_application => { kind: :property, name: "multiUserRotationApplication", is_optional: false },
    :single_user_rotation_application => { kind: :property, name: "singleUserRotationApplication", is_optional: false },
    :supports_read_replica_backups => { kind: :property, name: "supportsReadReplicaBackups", is_optional: true },
    :bind_to_instance => { kind: :method, name: "bindToInstance", is_optional: false },
  }
end

Instance Method Details

#bind_to_instance(scope, options) ⇒ AWSCDK::RDS::InstanceEngineConfig

Method called when the engine is used to create a new instance.

Parameters:

Returns:



84
85
86
87
88
89
 
# File 'rds/i_instance_engine.rb', line 84

def bind_to_instance(scope, options)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  options = options.is_a?(Hash) ? ::AWSCDK::RDS::InstanceEngineBindOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkluc3RhbmNlRW5naW5lQmluZE9wdGlvbnMifQ==")), "options")
  jsii_call_method("bindToInstance", [scope, options])
end

#default_username ⇒ String?

The default name of the master database user if one was not provided explicitly.

The global default of 'admin' will be used if this is undefined. Note that 'admin' is a reserved word in PostgreSQL and cannot be used.

Returns:

  • (String, nil) 


21
22
23
 
# File 'rds/i_instance_engine.rb', line 21

def default_username()
  jsii_get_property("defaultUsername")
end

#engine_family ⇒ String?

Note:

Default: - the engine doesn't belong to any family

The family this engine belongs to, like "MYSQL", or "POSTGRESQL".

This property is used when creating a Database Proxy. Most engines don't belong to any family (and because of that, you can't create Database Proxies for their Clusters or Instances).

Returns:

  • (String, nil) 


33
34
35
 
# File 'rds/i_instance_engine.rb', line 33

def engine_family()
  jsii_get_property("engineFamily")
end

#engine_type ⇒ String

The type of the engine, for example "mysql".

Returns:

  • (String) 


11
12
13
 
# File 'rds/i_instance_engine.rb', line 11

def engine_type()
  jsii_get_property("engineType")
end

#engine_version ⇒ AWSCDK::RDS::EngineVersion?

Note:

Default: - use the default version for this engine type

The exact version of the engine that is used, for example "5.1.42".

Returns:



41
42
43
 
# File 'rds/i_instance_engine.rb', line 41

def engine_version()
  jsii_get_property("engineVersion")
end

#multi_user_rotation_application ⇒ AWSCDK::SecretsManager::SecretRotationApplication

The application used by this engine to perform rotation for a multi-user scenario.

Returns:



60
61
62
 
# File 'rds/i_instance_engine.rb', line 60

def multi_user_rotation_application()
  jsii_get_property("multiUserRotationApplication")
end

#parameter_group_family ⇒ String?

Note:

Default: - the ParameterGroup family is not known (which means the major version of the engine is also not known)

The family to use for ParameterGroups using this engine.

This is usually equal to "", but can sometimes be a variation of that. You can pass this property when creating new ParameterGroup.

Returns:

  • (String, nil) 


53
54
55
 
# File 'rds/i_instance_engine.rb', line 53

def parameter_group_family()
  jsii_get_property("parameterGroupFamily")
end

#single_user_rotation_application ⇒ AWSCDK::SecretsManager::SecretRotationApplication

The application used by this engine to perform rotation for a single-user scenario.

Returns:



67
68
69
 
# File 'rds/i_instance_engine.rb', line 67

def single_user_rotation_application()
  jsii_get_property("singleUserRotationApplication")
end

#supports_read_replica_backups ⇒ Boolean?

Note:

Default: false

Whether this engine supports automatic backups of a read replica instance.

Returns:

  • (Boolean, nil) 


75
76
77
 
# File 'rds/i_instance_engine.rb', line 75

def supports_read_replica_backups()
  jsii_get_property("supportsReadReplicaBackups")
end