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



4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
# File 'lib/models/porcelain.rb', line 4883

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.



4843
4844
4845
# File 'lib/models/porcelain.rb', line 4843

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



4845
4846
4847
# File 'lib/models/porcelain.rb', line 4845

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



4847
4848
4849
# File 'lib/models/porcelain.rb', line 4847

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



4849
4850
4851
# File 'lib/models/porcelain.rb', line 4849

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



4851
4852
4853
# File 'lib/models/porcelain.rb', line 4851

def database
  @database
end

#egress_filterObject

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



4853
4854
4855
# File 'lib/models/porcelain.rb', line 4853

def egress_filter
  @egress_filter
end

#healthyObject

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



4855
4856
4857
# File 'lib/models/porcelain.rb', line 4855

def healthy
  @healthy
end

#hostnameObject

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



4857
4858
4859
# File 'lib/models/porcelain.rb', line 4857

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4859
4860
4861
# File 'lib/models/porcelain.rb', line 4859

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4861
4862
4863
# File 'lib/models/porcelain.rb', line 4861

def name
  @name
end

#passwordObject

The password to authenticate with.



4863
4864
4865
# File 'lib/models/porcelain.rb', line 4863

def password
  @password
end

#portObject

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



4865
4866
4867
# File 'lib/models/porcelain.rb', line 4865

def port
  @port
end

#port_overrideObject

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



4867
4868
4869
# File 'lib/models/porcelain.rb', line 4867

def port_override
  @port_override
end

#require_native_authObject

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



4869
4870
4871
# File 'lib/models/porcelain.rb', line 4869

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



4871
4872
4873
# File 'lib/models/porcelain.rb', line 4871

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



4873
4874
4875
# File 'lib/models/porcelain.rb', line 4873

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)



4875
4876
4877
# File 'lib/models/porcelain.rb', line 4875

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4877
4878
4879
# File 'lib/models/porcelain.rb', line 4877

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



4879
4880
4881
# File 'lib/models/porcelain.rb', line 4879

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



4881
4882
4883
# File 'lib/models/porcelain.rb', line 4881

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4927
4928
4929
4930
4931
4932
4933
# File 'lib/models/porcelain.rb', line 4927

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