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.



8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
# File 'lib/models/porcelain.rb', line 8055

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.



8013
8014
8015
# File 'lib/models/porcelain.rb', line 8013

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



8015
8016
8017
# File 'lib/models/porcelain.rb', line 8015

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



8017
8018
8019
# File 'lib/models/porcelain.rb', line 8017

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



8019
8020
8021
# File 'lib/models/porcelain.rb', line 8019

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



8021
8022
8023
# File 'lib/models/porcelain.rb', line 8021

def database
  @database
end

#egress_filterObject

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



8023
8024
8025
# File 'lib/models/porcelain.rb', line 8023

def egress_filter
  @egress_filter
end

#healthyObject

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



8025
8026
8027
# File 'lib/models/porcelain.rb', line 8025

def healthy
  @healthy
end

#hostnameObject

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



8027
8028
8029
# File 'lib/models/porcelain.rb', line 8027

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8029
8030
8031
# File 'lib/models/porcelain.rb', line 8029

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



8031
8032
8033
# File 'lib/models/porcelain.rb', line 8031

def name
  @name
end

#passwordObject

The password to authenticate with.



8033
8034
8035
# File 'lib/models/porcelain.rb', line 8033

def password
  @password
end

#portObject

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



8035
8036
8037
# File 'lib/models/porcelain.rb', line 8035

def port
  @port
end

#port_overrideObject

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



8037
8038
8039
# File 'lib/models/porcelain.rb', line 8037

def port_override
  @port_override
end

#proxy_cluster_idObject

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



8039
8040
8041
# File 'lib/models/porcelain.rb', line 8039

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)



8041
8042
8043
# File 'lib/models/porcelain.rb', line 8041

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



8043
8044
8045
# File 'lib/models/porcelain.rb', line 8043

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



8045
8046
8047
# File 'lib/models/porcelain.rb', line 8045

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)



8047
8048
8049
# File 'lib/models/porcelain.rb', line 8047

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8049
8050
8051
# File 'lib/models/porcelain.rb', line 8049

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



8051
8052
8053
# File 'lib/models/porcelain.rb', line 8051

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



8053
8054
8055
# File 'lib/models/porcelain.rb', line 8053

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8101
8102
8103
8104
8105
8106
8107
# File 'lib/models/porcelain.rb', line 8101

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