Module: AWSCDK::RDS::IEngine

Included in:
IClusterEngine, IInstanceEngine
Defined in:
rds/i_engine.rb

Overview

A common interface for database engines.

Don't implement this interface directly, instead implement one of the known sub-interfaces, like IClusterEngine and IInstanceEngine.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'rds/i_engine.rb', line 60

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 },
  }
end

Instance Method Details

#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) 


24
25
26
 
# File 'rds/i_engine.rb', line 24

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) 


36
37
38
 
# File 'rds/i_engine.rb', line 36

def engine_family()
  jsii_get_property("engineFamily")
end

#engine_type ⇒ String

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

Returns:

  • (String) 


14
15
16
 
# File 'rds/i_engine.rb', line 14

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:



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

def engine_version()
  jsii_get_property("engineVersion")
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) 


56
57
58
 
# File 'rds/i_engine.rb', line 56

def parameter_group_family()
  jsii_get_property("parameterGroupFamily")
end