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.



5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
# File 'lib/models/porcelain.rb', line 5754

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.



5716
5717
5718
# File 'lib/models/porcelain.rb', line 5716

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5718
5719
5720
# File 'lib/models/porcelain.rb', line 5718

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5720
5721
5722
# File 'lib/models/porcelain.rb', line 5720

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5722
5723
5724
# File 'lib/models/porcelain.rb', line 5722

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.



5724
5725
5726
# File 'lib/models/porcelain.rb', line 5724

def database
  @database
end

#egress_filterObject

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



5726
5727
5728
# File 'lib/models/porcelain.rb', line 5726

def egress_filter
  @egress_filter
end

#healthyObject

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



5728
5729
5730
# File 'lib/models/porcelain.rb', line 5728

def healthy
  @healthy
end

#hostnameObject

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



5730
5731
5732
# File 'lib/models/porcelain.rb', line 5730

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5732
5733
5734
# File 'lib/models/porcelain.rb', line 5732

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5734
5735
5736
# File 'lib/models/porcelain.rb', line 5734

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.



5736
5737
5738
# File 'lib/models/porcelain.rb', line 5736

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5738
5739
5740
# File 'lib/models/porcelain.rb', line 5738

def password
  @password
end

#portObject

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



5740
5741
5742
# File 'lib/models/porcelain.rb', line 5740

def port
  @port
end

#port_overrideObject

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



5742
5743
5744
# File 'lib/models/porcelain.rb', line 5742

def port_override
  @port_override
end

#secret_store_idObject

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



5744
5745
5746
# File 'lib/models/porcelain.rb', line 5744

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5746
5747
5748
# File 'lib/models/porcelain.rb', line 5746

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)



5748
5749
5750
# File 'lib/models/porcelain.rb', line 5748

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5750
5751
5752
# File 'lib/models/porcelain.rb', line 5750

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5752
5753
5754
# File 'lib/models/porcelain.rb', line 5752

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5796
5797
5798
5799
5800
5801
5802
# File 'lib/models/porcelain.rb', line 5796

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