Class: SDM::MTLSPostgres

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

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, override_database: nil, password: nil, port: nil, port_override: nil, secret_store_id: nil, server_name: nil, subdomain: nil, tags: nil, username: nil) ⇒ MTLSPostgres

Returns a new instance of MTLSPostgres.



5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
# File 'lib/models/porcelain.rb', line 5240

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,
  override_database: nil,
  password: nil,
  port: nil,
  port_override: nil,
  secret_store_id: nil,
  server_name: nil,
  subdomain: nil,
  tags: 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
  @override_database = override_database == nil ? false : override_database
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @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
  @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.



5202
5203
5204
# File 'lib/models/porcelain.rb', line 5202

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5204
5205
5206
# File 'lib/models/porcelain.rb', line 5204

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5206
5207
5208
# File 'lib/models/porcelain.rb', line 5206

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5208
5209
5210
# File 'lib/models/porcelain.rb', line 5208

def client_key
  @client_key
end

#databaseObject

The initial database to connect to. This setting does not by itself prevent switching to another database after connecting.



5210
5211
5212
# File 'lib/models/porcelain.rb', line 5210

def database
  @database
end

#egress_filterObject

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



5212
5213
5214
# File 'lib/models/porcelain.rb', line 5212

def egress_filter
  @egress_filter
end

#healthyObject

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



5214
5215
5216
# File 'lib/models/porcelain.rb', line 5214

def healthy
  @healthy
end

#hostnameObject

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



5216
5217
5218
# File 'lib/models/porcelain.rb', line 5216

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5218
5219
5220
# File 'lib/models/porcelain.rb', line 5218

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5220
5221
5222
# File 'lib/models/porcelain.rb', line 5220

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



5222
5223
5224
# File 'lib/models/porcelain.rb', line 5222

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5224
5225
5226
# File 'lib/models/porcelain.rb', line 5224

def password
  @password
end

#portObject

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



5226
5227
5228
# File 'lib/models/porcelain.rb', line 5226

def port
  @port
end

#port_overrideObject

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



5228
5229
5230
# File 'lib/models/porcelain.rb', line 5228

def port_override
  @port_override
end

#secret_store_idObject

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



5230
5231
5232
# File 'lib/models/porcelain.rb', line 5230

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5232
5233
5234
# File 'lib/models/porcelain.rb', line 5232

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)



5234
5235
5236
# File 'lib/models/porcelain.rb', line 5234

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5236
5237
5238
# File 'lib/models/porcelain.rb', line 5236

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5238
5239
5240
# File 'lib/models/porcelain.rb', line 5238

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5282
5283
5284
5285
5286
5287
5288
# File 'lib/models/porcelain.rb', line 5282

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