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.



7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
# File 'lib/models/porcelain.rb', line 7288

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.



7246
7247
7248
# File 'lib/models/porcelain.rb', line 7246

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



7248
7249
7250
# File 'lib/models/porcelain.rb', line 7248

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



7250
7251
7252
# File 'lib/models/porcelain.rb', line 7250

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



7252
7253
7254
# File 'lib/models/porcelain.rb', line 7252

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



7254
7255
7256
# File 'lib/models/porcelain.rb', line 7254

def database
  @database
end

#egress_filterObject

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



7256
7257
7258
# File 'lib/models/porcelain.rb', line 7256

def egress_filter
  @egress_filter
end

#healthyObject

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



7258
7259
7260
# File 'lib/models/porcelain.rb', line 7258

def healthy
  @healthy
end

#hostnameObject

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



7260
7261
7262
# File 'lib/models/porcelain.rb', line 7260

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7262
7263
7264
# File 'lib/models/porcelain.rb', line 7262

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



7264
7265
7266
# File 'lib/models/porcelain.rb', line 7264

def name
  @name
end

#passwordObject

The password to authenticate with.



7266
7267
7268
# File 'lib/models/porcelain.rb', line 7266

def password
  @password
end

#portObject

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



7268
7269
7270
# File 'lib/models/porcelain.rb', line 7268

def port
  @port
end

#port_overrideObject

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



7270
7271
7272
# File 'lib/models/porcelain.rb', line 7270

def port_override
  @port_override
end

#proxy_cluster_idObject

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



7272
7273
7274
# File 'lib/models/porcelain.rb', line 7272

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)



7274
7275
7276
# File 'lib/models/porcelain.rb', line 7274

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



7276
7277
7278
# File 'lib/models/porcelain.rb', line 7276

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



7278
7279
7280
# File 'lib/models/porcelain.rb', line 7278

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)



7280
7281
7282
# File 'lib/models/porcelain.rb', line 7280

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7282
7283
7284
# File 'lib/models/porcelain.rb', line 7282

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



7284
7285
7286
# File 'lib/models/porcelain.rb', line 7284

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



7286
7287
7288
# File 'lib/models/porcelain.rb', line 7286

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



7334
7335
7336
7337
7338
7339
7340
# File 'lib/models/porcelain.rb', line 7334

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