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.



7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
# File 'lib/models/porcelain.rb', line 7900

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.



7858
7859
7860
# File 'lib/models/porcelain.rb', line 7858

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



7860
7861
7862
# File 'lib/models/porcelain.rb', line 7860

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



7862
7863
7864
# File 'lib/models/porcelain.rb', line 7862

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



7864
7865
7866
# File 'lib/models/porcelain.rb', line 7864

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



7866
7867
7868
# File 'lib/models/porcelain.rb', line 7866

def database
  @database
end

#egress_filterObject

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



7868
7869
7870
# File 'lib/models/porcelain.rb', line 7868

def egress_filter
  @egress_filter
end

#healthyObject

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



7870
7871
7872
# File 'lib/models/porcelain.rb', line 7870

def healthy
  @healthy
end

#hostnameObject

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



7872
7873
7874
# File 'lib/models/porcelain.rb', line 7872

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7874
7875
7876
# File 'lib/models/porcelain.rb', line 7874

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



7876
7877
7878
# File 'lib/models/porcelain.rb', line 7876

def name
  @name
end

#passwordObject

The password to authenticate with.



7878
7879
7880
# File 'lib/models/porcelain.rb', line 7878

def password
  @password
end

#portObject

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



7880
7881
7882
# File 'lib/models/porcelain.rb', line 7880

def port
  @port
end

#port_overrideObject

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



7882
7883
7884
# File 'lib/models/porcelain.rb', line 7882

def port_override
  @port_override
end

#proxy_cluster_idObject

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



7884
7885
7886
# File 'lib/models/porcelain.rb', line 7884

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)



7886
7887
7888
# File 'lib/models/porcelain.rb', line 7886

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



7888
7889
7890
# File 'lib/models/porcelain.rb', line 7888

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



7890
7891
7892
# File 'lib/models/porcelain.rb', line 7890

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)



7892
7893
7894
# File 'lib/models/porcelain.rb', line 7892

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7894
7895
7896
# File 'lib/models/porcelain.rb', line 7894

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



7896
7897
7898
# File 'lib/models/porcelain.rb', line 7896

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



7898
7899
7900
# File 'lib/models/porcelain.rb', line 7898

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



7946
7947
7948
7949
7950
7951
7952
# File 'lib/models/porcelain.rb', line 7946

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