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, 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.



5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
# File 'lib/models/porcelain.rb', line 5743

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,
  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
  @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.



5703
5704
5705
# File 'lib/models/porcelain.rb', line 5703

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5705
5706
5707
# File 'lib/models/porcelain.rb', line 5705

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5707
5708
5709
# File 'lib/models/porcelain.rb', line 5707

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5709
5710
5711
# File 'lib/models/porcelain.rb', line 5709

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



5711
5712
5713
# File 'lib/models/porcelain.rb', line 5711

def database
  @database
end

#egress_filterObject

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



5713
5714
5715
# File 'lib/models/porcelain.rb', line 5713

def egress_filter
  @egress_filter
end

#healthyObject

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



5715
5716
5717
# File 'lib/models/porcelain.rb', line 5715

def healthy
  @healthy
end

#hostnameObject

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



5717
5718
5719
# File 'lib/models/porcelain.rb', line 5717

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5719
5720
5721
# File 'lib/models/porcelain.rb', line 5719

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5721
5722
5723
# File 'lib/models/porcelain.rb', line 5721

def name
  @name
end

#passwordObject

The password to authenticate with.



5723
5724
5725
# File 'lib/models/porcelain.rb', line 5723

def password
  @password
end

#portObject

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



5725
5726
5727
# File 'lib/models/porcelain.rb', line 5725

def port
  @port
end

#port_overrideObject

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



5727
5728
5729
# File 'lib/models/porcelain.rb', line 5727

def port_override
  @port_override
end

#require_native_authObject

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



5729
5730
5731
# File 'lib/models/porcelain.rb', line 5729

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



5731
5732
5733
# File 'lib/models/porcelain.rb', line 5731

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5733
5734
5735
# File 'lib/models/porcelain.rb', line 5733

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)



5735
5736
5737
# File 'lib/models/porcelain.rb', line 5735

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5737
5738
5739
# File 'lib/models/porcelain.rb', line 5737

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



5739
5740
5741
# File 'lib/models/porcelain.rb', line 5739

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



5741
5742
5743
# File 'lib/models/porcelain.rb', line 5741

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5787
5788
5789
5790
5791
5792
5793
# File 'lib/models/porcelain.rb', line 5787

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