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.



8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
 
# File 'lib/models/porcelain.rb', line 8489

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.



8449
8450
8451
 
# File 'lib/models/porcelain.rb', line 8449

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



8451
8452
8453
 
# File 'lib/models/porcelain.rb', line 8451

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



8453
8454
8455
 
# File 'lib/models/porcelain.rb', line 8453

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



8455
8456
8457
 
# File 'lib/models/porcelain.rb', line 8455

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.



8457
8458
8459
 
# File 'lib/models/porcelain.rb', line 8457

def database
  @database
end

#egress_filter ⇒ Object

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



8459
8460
8461
 
# File 'lib/models/porcelain.rb', line 8459

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8461
8462
8463
 
# File 'lib/models/porcelain.rb', line 8461

def healthy
  @healthy
end

#hostname ⇒ Object

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



8463
8464
8465
 
# File 'lib/models/porcelain.rb', line 8463

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8465
8466
8467
 
# File 'lib/models/porcelain.rb', line 8465

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



8467
8468
8469
 
# File 'lib/models/porcelain.rb', line 8467

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.



8469
8470
8471
 
# File 'lib/models/porcelain.rb', line 8469

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



8471
8472
8473
 
# File 'lib/models/porcelain.rb', line 8471

def password
  @password
end

#port ⇒ Object

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



8473
8474
8475
 
# File 'lib/models/porcelain.rb', line 8473

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.



8475
8476
8477
 
# File 'lib/models/porcelain.rb', line 8475

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



8477
8478
8479
 
# File 'lib/models/porcelain.rb', line 8477

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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



8479
8480
8481
 
# File 'lib/models/porcelain.rb', line 8479

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



8481
8482
8483
 
# File 'lib/models/porcelain.rb', line 8481

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.



8483
8484
8485
 
# File 'lib/models/porcelain.rb', line 8483

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8485
8486
8487
 
# File 'lib/models/porcelain.rb', line 8485

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8487
8488
8489
 
# File 'lib/models/porcelain.rb', line 8487

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8533
8534
8535
8536
8537
8538
8539
 
# File 'lib/models/porcelain.rb', line 8533

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