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.



5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
# File 'lib/models/porcelain.rb', line 5808

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.



5768
5769
5770
# File 'lib/models/porcelain.rb', line 5768

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5770
5771
5772
# File 'lib/models/porcelain.rb', line 5770

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5772
5773
5774
# File 'lib/models/porcelain.rb', line 5772

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5774
5775
5776
# File 'lib/models/porcelain.rb', line 5774

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



5776
5777
5778
# File 'lib/models/porcelain.rb', line 5776

def database
  @database
end

#egress_filterObject

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



5778
5779
5780
# File 'lib/models/porcelain.rb', line 5778

def egress_filter
  @egress_filter
end

#healthyObject

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



5780
5781
5782
# File 'lib/models/porcelain.rb', line 5780

def healthy
  @healthy
end

#hostnameObject

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



5782
5783
5784
# File 'lib/models/porcelain.rb', line 5782

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5784
5785
5786
# File 'lib/models/porcelain.rb', line 5784

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5786
5787
5788
# File 'lib/models/porcelain.rb', line 5786

def name
  @name
end

#passwordObject

The password to authenticate with.



5788
5789
5790
# File 'lib/models/porcelain.rb', line 5788

def password
  @password
end

#portObject

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



5790
5791
5792
# File 'lib/models/porcelain.rb', line 5790

def port
  @port
end

#port_overrideObject

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



5792
5793
5794
# File 'lib/models/porcelain.rb', line 5792

def port_override
  @port_override
end

#require_native_authObject

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



5794
5795
5796
# File 'lib/models/porcelain.rb', line 5794

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



5796
5797
5798
# File 'lib/models/porcelain.rb', line 5796

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5798
5799
5800
# File 'lib/models/porcelain.rb', line 5798

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)



5800
5801
5802
# File 'lib/models/porcelain.rb', line 5800

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5802
5803
5804
# File 'lib/models/porcelain.rb', line 5802

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



5804
5805
5806
# File 'lib/models/porcelain.rb', line 5804

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



5806
5807
5808
# File 'lib/models/porcelain.rb', line 5806

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5852
5853
5854
5855
5856
5857
5858
# File 'lib/models/porcelain.rb', line 5852

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