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.



5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
# File 'lib/models/porcelain.rb', line 5147

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.



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

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



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

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



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

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



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

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



5115
5116
5117
# File 'lib/models/porcelain.rb', line 5115

def database
  @database
end

#egress_filterObject

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



5117
5118
5119
# File 'lib/models/porcelain.rb', line 5117

def egress_filter
  @egress_filter
end

#healthyObject

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



5119
5120
5121
# File 'lib/models/porcelain.rb', line 5119

def healthy
  @healthy
end

#hostnameObject

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



5121
5122
5123
# File 'lib/models/porcelain.rb', line 5121

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5123
5124
5125
# File 'lib/models/porcelain.rb', line 5123

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5125
5126
5127
# File 'lib/models/porcelain.rb', line 5125

def name
  @name
end

#passwordObject

The password to authenticate with.



5127
5128
5129
# File 'lib/models/porcelain.rb', line 5127

def password
  @password
end

#portObject

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



5129
5130
5131
# File 'lib/models/porcelain.rb', line 5129

def port
  @port
end

#port_overrideObject

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



5131
5132
5133
# File 'lib/models/porcelain.rb', line 5131

def port_override
  @port_override
end

#require_native_authObject

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



5133
5134
5135
# File 'lib/models/porcelain.rb', line 5133

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



5135
5136
5137
# File 'lib/models/porcelain.rb', line 5135

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5137
5138
5139
# File 'lib/models/porcelain.rb', line 5137

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)



5139
5140
5141
# File 'lib/models/porcelain.rb', line 5139

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5141
5142
5143
# File 'lib/models/porcelain.rb', line 5141

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



5143
5144
5145
# File 'lib/models/porcelain.rb', line 5143

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



5145
5146
5147
# File 'lib/models/porcelain.rb', line 5145

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5191
5192
5193
5194
5195
5196
5197
# File 'lib/models/porcelain.rb', line 5191

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