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.



8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
# File 'lib/models/porcelain.rb', line 8393

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



8351
8352
8353
# File 'lib/models/porcelain.rb', line 8351

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



8353
8354
8355
# File 'lib/models/porcelain.rb', line 8353

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



8355
8356
8357
# File 'lib/models/porcelain.rb', line 8355

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



8357
8358
8359
# File 'lib/models/porcelain.rb', line 8357

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



8359
8360
8361
# File 'lib/models/porcelain.rb', line 8359

def database
  @database
end

#egress_filterObject

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



8361
8362
8363
# File 'lib/models/porcelain.rb', line 8361

def egress_filter
  @egress_filter
end

#healthyObject

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



8363
8364
8365
# File 'lib/models/porcelain.rb', line 8363

def healthy
  @healthy
end

#hostnameObject

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



8365
8366
8367
# File 'lib/models/porcelain.rb', line 8365

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8367
8368
8369
# File 'lib/models/porcelain.rb', line 8367

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



8369
8370
8371
# File 'lib/models/porcelain.rb', line 8369

def name
  @name
end

#passwordObject

The password to authenticate with.



8371
8372
8373
# File 'lib/models/porcelain.rb', line 8371

def password
  @password
end

#portObject

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



8373
8374
8375
# File 'lib/models/porcelain.rb', line 8373

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



8375
8376
8377
# File 'lib/models/porcelain.rb', line 8375

def port_override
  @port_override
end

#proxy_cluster_idObject

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



8377
8378
8379
# File 'lib/models/porcelain.rb', line 8377

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)



8379
8380
8381
# File 'lib/models/porcelain.rb', line 8379

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



8381
8382
8383
# File 'lib/models/porcelain.rb', line 8381

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



8383
8384
8385
# File 'lib/models/porcelain.rb', line 8383

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)



8385
8386
8387
# File 'lib/models/porcelain.rb', line 8385

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8387
8388
8389
# File 'lib/models/porcelain.rb', line 8387

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



8389
8390
8391
# File 'lib/models/porcelain.rb', line 8389

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



8391
8392
8393
# File 'lib/models/porcelain.rb', line 8391

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8439
8440
8441
8442
8443
8444
8445
# File 'lib/models/porcelain.rb', line 8439

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