Class: SDM::MTLSMysql

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

MTLSMysql is currently unstable, and its API may change, or it may be removed, without a major version bump.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, certificate_authority: nil, client_certificate: nil, client_key: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, name: nil, password: nil, port: nil, port_override: nil, proxy_cluster_id: nil, require_native_auth: nil, secret_store_id: nil, server_name: nil, subdomain: nil, tags: nil, use_azure_single_server_usernames: nil, username: nil) ⇒ MTLSMysql

Returns a new instance of MTLSMysql.



8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
# File 'lib/models/porcelain.rb', line 8217

def initialize(
  bind_interface: nil,
  certificate_authority: nil,
  client_certificate: nil,
  client_key: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  password: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  require_native_auth: nil,
  secret_store_id: nil,
  server_name: nil,
  subdomain: nil,
  tags: nil,
  use_azure_single_server_usernames: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @certificate_authority = certificate_authority == nil ? "" : certificate_authority
  @client_certificate = client_certificate == nil ? "" : client_certificate
  @client_key = client_key == nil ? "" : client_key
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @require_native_auth = require_native_auth == nil ? false : require_native_auth
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_name = server_name == nil ? "" : server_name
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @use_azure_single_server_usernames = use_azure_single_server_usernames == nil ? false : use_azure_single_server_usernames
  @username = username == nil ? "" : username
end

Instance Attribute Details

#bind_interfaceObject

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.



8175
8176
8177
# File 'lib/models/porcelain.rb', line 8175

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



8177
8178
8179
# File 'lib/models/porcelain.rb', line 8177

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



8179
8180
8181
# File 'lib/models/porcelain.rb', line 8179

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



8181
8182
8183
# File 'lib/models/porcelain.rb', line 8181

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



8183
8184
8185
# File 'lib/models/porcelain.rb', line 8183

def database
  @database
end

#egress_filterObject

A filter applied to the routing logic to pin datasource to nodes.



8185
8186
8187
# File 'lib/models/porcelain.rb', line 8185

def egress_filter
  @egress_filter
end

#healthyObject

True if the datasource is reachable and the credentials are valid.



8187
8188
8189
# File 'lib/models/porcelain.rb', line 8187

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



8189
8190
8191
# File 'lib/models/porcelain.rb', line 8189

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8191
8192
8193
# File 'lib/models/porcelain.rb', line 8191

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



8193
8194
8195
# File 'lib/models/porcelain.rb', line 8193

def name
  @name
end

#passwordObject

The password to authenticate with.



8195
8196
8197
# File 'lib/models/porcelain.rb', line 8195

def password
  @password
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



8197
8198
8199
# File 'lib/models/porcelain.rb', line 8197

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource.



8199
8200
8201
# File 'lib/models/porcelain.rb', line 8199

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



8201
8202
8203
# File 'lib/models/porcelain.rb', line 8201

def proxy_cluster_id
  @proxy_cluster_id
end

#require_native_authObject

Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)



8203
8204
8205
# File 'lib/models/porcelain.rb', line 8203

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

ID of the secret store containing credentials for this resource, if any.



8205
8206
8207
# File 'lib/models/porcelain.rb', line 8205

def secret_store_id
  @secret_store_id
end

#server_nameObject

Server name for TLS verification (unverified by StrongDM if empty)



8207
8208
8209
# File 'lib/models/porcelain.rb', line 8207

def server_name
  @server_name
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



8209
8210
8211
# File 'lib/models/porcelain.rb', line 8209

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8211
8212
8213
# File 'lib/models/porcelain.rb', line 8211

def tags
  @tags
end

#use_azure_single_server_usernamesObject

If true, appends the hostname to the username when hitting a database.azure.com address



8213
8214
8215
# File 'lib/models/porcelain.rb', line 8213

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



8215
8216
8217
# File 'lib/models/porcelain.rb', line 8215

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8263
8264
8265
8266
8267
8268
8269
# File 'lib/models/porcelain.rb', line 8263

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end