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.



6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
# File 'lib/models/porcelain.rb', line 6302

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.



6264
6265
6266
# File 'lib/models/porcelain.rb', line 6264

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



6266
6267
6268
# File 'lib/models/porcelain.rb', line 6266

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



6268
6269
6270
# File 'lib/models/porcelain.rb', line 6268

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



6270
6271
6272
# File 'lib/models/porcelain.rb', line 6270

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.



6272
6273
6274
# File 'lib/models/porcelain.rb', line 6272

def database
  @database
end

#egress_filterObject

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



6274
6275
6276
# File 'lib/models/porcelain.rb', line 6274

def egress_filter
  @egress_filter
end

#healthyObject

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



6276
6277
6278
# File 'lib/models/porcelain.rb', line 6276

def healthy
  @healthy
end

#hostnameObject

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



6278
6279
6280
# File 'lib/models/porcelain.rb', line 6278

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6280
6281
6282
# File 'lib/models/porcelain.rb', line 6280

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6282
6283
6284
# File 'lib/models/porcelain.rb', line 6282

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.



6284
6285
6286
# File 'lib/models/porcelain.rb', line 6284

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



6286
6287
6288
# File 'lib/models/porcelain.rb', line 6286

def password
  @password
end

#portObject

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



6288
6289
6290
# File 'lib/models/porcelain.rb', line 6288

def port
  @port
end

#port_overrideObject

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



6290
6291
6292
# File 'lib/models/porcelain.rb', line 6290

def port_override
  @port_override
end

#secret_store_idObject

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



6292
6293
6294
# File 'lib/models/porcelain.rb', line 6292

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



6294
6295
6296
# File 'lib/models/porcelain.rb', line 6294

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)



6296
6297
6298
# File 'lib/models/porcelain.rb', line 6296

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6298
6299
6300
# File 'lib/models/porcelain.rb', line 6298

def tags
  @tags
end

#usernameObject

The username to authenticate with.



6300
6301
6302
# File 'lib/models/porcelain.rb', line 6300

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6344
6345
6346
6347
6348
6349
6350
# File 'lib/models/porcelain.rb', line 6344

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