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.



6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
# File 'lib/models/porcelain.rb', line 6146

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.



6106
6107
6108
# File 'lib/models/porcelain.rb', line 6106

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



6108
6109
6110
# File 'lib/models/porcelain.rb', line 6108

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



6110
6111
6112
# File 'lib/models/porcelain.rb', line 6110

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



6112
6113
6114
# File 'lib/models/porcelain.rb', line 6112

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



6114
6115
6116
# File 'lib/models/porcelain.rb', line 6114

def database
  @database
end

#egress_filterObject

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



6116
6117
6118
# File 'lib/models/porcelain.rb', line 6116

def egress_filter
  @egress_filter
end

#healthyObject

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



6118
6119
6120
# File 'lib/models/porcelain.rb', line 6118

def healthy
  @healthy
end

#hostnameObject

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



6120
6121
6122
# File 'lib/models/porcelain.rb', line 6120

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6122
6123
6124
# File 'lib/models/porcelain.rb', line 6122

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6124
6125
6126
# File 'lib/models/porcelain.rb', line 6124

def name
  @name
end

#passwordObject

The password to authenticate with.



6126
6127
6128
# File 'lib/models/porcelain.rb', line 6126

def password
  @password
end

#portObject

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



6128
6129
6130
# File 'lib/models/porcelain.rb', line 6128

def port
  @port
end

#port_overrideObject

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



6130
6131
6132
# File 'lib/models/porcelain.rb', line 6130

def port_override
  @port_override
end

#require_native_authObject

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



6132
6133
6134
# File 'lib/models/porcelain.rb', line 6132

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



6134
6135
6136
# File 'lib/models/porcelain.rb', line 6134

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



6136
6137
6138
# File 'lib/models/porcelain.rb', line 6136

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)



6138
6139
6140
# File 'lib/models/porcelain.rb', line 6138

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6140
6141
6142
# File 'lib/models/porcelain.rb', line 6140

def tags
  @tags
end

#use_azure_single_server_usernamesObject

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



6142
6143
6144
# File 'lib/models/porcelain.rb', line 6142

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



6144
6145
6146
# File 'lib/models/porcelain.rb', line 6144

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6190
6191
6192
6193
6194
6195
6196
# File 'lib/models/porcelain.rb', line 6190

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