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.



9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
 
# File 'lib/models/porcelain.rb', line 9508

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.



9468
9469
9470
 
# File 'lib/models/porcelain.rb', line 9468

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



9470
9471
9472
 
# File 'lib/models/porcelain.rb', line 9470

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



9472
9473
9474
 
# File 'lib/models/porcelain.rb', line 9472

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



9474
9475
9476
 
# File 'lib/models/porcelain.rb', line 9474

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.



9476
9477
9478
 
# File 'lib/models/porcelain.rb', line 9476

def database
  @database
end

#egress_filter ⇒ Object

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



9478
9479
9480
 
# File 'lib/models/porcelain.rb', line 9478

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



9480
9481
9482
 
# File 'lib/models/porcelain.rb', line 9480

def healthy
  @healthy
end

#hostname ⇒ Object

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



9482
9483
9484
 
# File 'lib/models/porcelain.rb', line 9482

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9484
9485
9486
 
# File 'lib/models/porcelain.rb', line 9484

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



9486
9487
9488
 
# File 'lib/models/porcelain.rb', line 9486

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.



9488
9489
9490
 
# File 'lib/models/porcelain.rb', line 9488

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



9490
9491
9492
 
# File 'lib/models/porcelain.rb', line 9490

def password
  @password
end

#port ⇒ Object

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



9492
9493
9494
 
# File 'lib/models/porcelain.rb', line 9492

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.



9494
9495
9496
 
# File 'lib/models/porcelain.rb', line 9494

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



9496
9497
9498
 
# File 'lib/models/porcelain.rb', line 9496

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



9498
9499
9500
 
# File 'lib/models/porcelain.rb', line 9498

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



9500
9501
9502
 
# File 'lib/models/porcelain.rb', line 9500

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.



9502
9503
9504
 
# File 'lib/models/porcelain.rb', line 9502

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9504
9505
9506
 
# File 'lib/models/porcelain.rb', line 9504

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9506
9507
9508
 
# File 'lib/models/porcelain.rb', line 9506

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9552
9553
9554
9555
9556
9557
9558
 
# File 'lib/models/porcelain.rb', line 9552

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