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.



5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
# File 'lib/models/porcelain.rb', line 5114

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.



5074
5075
5076
# File 'lib/models/porcelain.rb', line 5074

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5076
5077
5078
# File 'lib/models/porcelain.rb', line 5076

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5078
5079
5080
# File 'lib/models/porcelain.rb', line 5078

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5080
5081
5082
# File 'lib/models/porcelain.rb', line 5080

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



5082
5083
5084
# File 'lib/models/porcelain.rb', line 5082

def database
  @database
end

#egress_filterObject

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



5084
5085
5086
# File 'lib/models/porcelain.rb', line 5084

def egress_filter
  @egress_filter
end

#healthyObject

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



5086
5087
5088
# File 'lib/models/porcelain.rb', line 5086

def healthy
  @healthy
end

#hostnameObject

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



5088
5089
5090
# File 'lib/models/porcelain.rb', line 5088

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5090
5091
5092
# File 'lib/models/porcelain.rb', line 5090

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5092
5093
5094
# File 'lib/models/porcelain.rb', line 5092

def name
  @name
end

#passwordObject

The password to authenticate with.



5094
5095
5096
# File 'lib/models/porcelain.rb', line 5094

def password
  @password
end

#portObject

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



5096
5097
5098
# File 'lib/models/porcelain.rb', line 5096

def port
  @port
end

#port_overrideObject

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



5098
5099
5100
# File 'lib/models/porcelain.rb', line 5098

def port_override
  @port_override
end

#require_native_authObject

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



5100
5101
5102
# File 'lib/models/porcelain.rb', line 5100

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



5102
5103
5104
# File 'lib/models/porcelain.rb', line 5102

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5104
5105
5106
# File 'lib/models/porcelain.rb', line 5104

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)



5106
5107
5108
# File 'lib/models/porcelain.rb', line 5106

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5108
5109
5110
# File 'lib/models/porcelain.rb', line 5108

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



5110
5111
5112
# File 'lib/models/porcelain.rb', line 5110

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



5112
5113
5114
# File 'lib/models/porcelain.rb', line 5112

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5158
5159
5160
5161
5162
5163
5164
# File 'lib/models/porcelain.rb', line 5158

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