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.



8392
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
 
# File 'lib/models/porcelain.rb', line 8392

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_interface ⇒ Object

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.



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

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



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

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



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

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



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

def client_key
  @client_key
end

#database ⇒ Object

The database for healthchecks. Does not affect client requests.



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

def database
  @database
end

#egress_filter ⇒ Object

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



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

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



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

def healthy
  @healthy
end

#hostname ⇒ Object

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



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

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



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

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



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

def name
  @name
end

#password ⇒ Object

The password to authenticate with.



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

def password
  @password
end

#port ⇒ Object

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



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

def port
  @port
end

#port_override ⇒ Object

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.



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

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



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

def proxy_cluster_id
  @proxy_cluster_id
end

#require_native_auth ⇒ Object

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



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

def require_native_auth
  @require_native_auth
end

#secret_store_id ⇒ Object

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



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

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



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

def server_name
  @server_name
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



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

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

#use_azure_single_server_usernames ⇒ Object

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



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

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#username ⇒ Object

The username to authenticate with.



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

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



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

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