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, proxy_cluster_id: nil, secret_store_id: nil, server_name: nil, subdomain: nil, tags: nil, username: nil) ⇒ MTLSPostgres

Returns a new instance of MTLSPostgres.



9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
 
# File 'lib/models/porcelain.rb', line 9423

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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_interface ⇒ Object

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



9383
9384
9385
 
# File 'lib/models/porcelain.rb', line 9383

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



9385
9386
9387
 
# File 'lib/models/porcelain.rb', line 9385

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



9387
9388
9389
 
# File 'lib/models/porcelain.rb', line 9387

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



9389
9390
9391
 
# File 'lib/models/porcelain.rb', line 9389

def client_key
  @client_key
end

#database ⇒ Object

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



9391
9392
9393
 
# File 'lib/models/porcelain.rb', line 9391

def database
  @database
end

#egress_filter ⇒ Object

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



9393
9394
9395
 
# File 'lib/models/porcelain.rb', line 9393

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9395
9396
9397
 
# File 'lib/models/porcelain.rb', line 9395

def healthy
  @healthy
end

#hostname ⇒ Object

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



9397
9398
9399
 
# File 'lib/models/porcelain.rb', line 9397

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9399
9400
9401
 
# File 'lib/models/porcelain.rb', line 9399

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



9401
9402
9403
 
# File 'lib/models/porcelain.rb', line 9401

def name
  @name
end

#override_database ⇒ Object

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.



9403
9404
9405
 
# File 'lib/models/porcelain.rb', line 9403

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



9405
9406
9407
 
# File 'lib/models/porcelain.rb', line 9405

def password
  @password
end

#port ⇒ Object

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



9407
9408
9409
 
# File 'lib/models/porcelain.rb', line 9407

def port
  @port
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



9409
9410
9411
 
# File 'lib/models/porcelain.rb', line 9409

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



9411
9412
9413
 
# File 'lib/models/porcelain.rb', line 9411

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



9413
9414
9415
 
# File 'lib/models/porcelain.rb', line 9413

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



9415
9416
9417
 
# File 'lib/models/porcelain.rb', line 9415

def server_name
  @server_name
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



9417
9418
9419
 
# File 'lib/models/porcelain.rb', line 9417

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9419
9420
9421
 
# File 'lib/models/porcelain.rb', line 9419

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9421
9422
9423
 
# File 'lib/models/porcelain.rb', line 9421

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9467
9468
9469
9470
9471
9472
9473
 
# File 'lib/models/porcelain.rb', line 9467

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