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.



6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
# File 'lib/models/porcelain.rb', line 6900

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.



6858
6859
6860
# File 'lib/models/porcelain.rb', line 6858

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



6860
6861
6862
# File 'lib/models/porcelain.rb', line 6860

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



6862
6863
6864
# File 'lib/models/porcelain.rb', line 6862

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



6864
6865
6866
# File 'lib/models/porcelain.rb', line 6864

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



6866
6867
6868
# File 'lib/models/porcelain.rb', line 6866

def database
  @database
end

#egress_filterObject

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



6868
6869
6870
# File 'lib/models/porcelain.rb', line 6868

def egress_filter
  @egress_filter
end

#healthyObject

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



6870
6871
6872
# File 'lib/models/porcelain.rb', line 6870

def healthy
  @healthy
end

#hostnameObject

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



6872
6873
6874
# File 'lib/models/porcelain.rb', line 6872

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6874
6875
6876
# File 'lib/models/porcelain.rb', line 6874

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6876
6877
6878
# File 'lib/models/porcelain.rb', line 6876

def name
  @name
end

#passwordObject

The password to authenticate with.



6878
6879
6880
# File 'lib/models/porcelain.rb', line 6878

def password
  @password
end

#portObject

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



6880
6881
6882
# File 'lib/models/porcelain.rb', line 6880

def port
  @port
end

#port_overrideObject

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



6882
6883
6884
# File 'lib/models/porcelain.rb', line 6882

def port_override
  @port_override
end

#proxy_cluster_idObject

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



6884
6885
6886
# File 'lib/models/porcelain.rb', line 6884

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)



6886
6887
6888
# File 'lib/models/porcelain.rb', line 6886

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



6888
6889
6890
# File 'lib/models/porcelain.rb', line 6888

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



6890
6891
6892
# File 'lib/models/porcelain.rb', line 6890

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)



6892
6893
6894
# File 'lib/models/porcelain.rb', line 6892

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6894
6895
6896
# File 'lib/models/porcelain.rb', line 6894

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



6896
6897
6898
# File 'lib/models/porcelain.rb', line 6896

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



6898
6899
6900
# File 'lib/models/porcelain.rb', line 6898

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6946
6947
6948
6949
6950
6951
6952
# File 'lib/models/porcelain.rb', line 6946

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