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.



4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
# File 'lib/models/porcelain.rb', line 4820

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.



4782
4783
4784
# File 'lib/models/porcelain.rb', line 4782

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



4784
4785
4786
# File 'lib/models/porcelain.rb', line 4784

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



4786
4787
4788
# File 'lib/models/porcelain.rb', line 4786

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



4788
4789
4790
# File 'lib/models/porcelain.rb', line 4788

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.



4790
4791
4792
# File 'lib/models/porcelain.rb', line 4790

def database
  @database
end

#egress_filterObject

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



4792
4793
4794
# File 'lib/models/porcelain.rb', line 4792

def egress_filter
  @egress_filter
end

#healthyObject

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



4794
4795
4796
# File 'lib/models/porcelain.rb', line 4794

def healthy
  @healthy
end

#hostnameObject

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



4796
4797
4798
# File 'lib/models/porcelain.rb', line 4796

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



4798
4799
4800
# File 'lib/models/porcelain.rb', line 4798

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



4800
4801
4802
# File 'lib/models/porcelain.rb', line 4800

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.



4802
4803
4804
# File 'lib/models/porcelain.rb', line 4802

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



4804
4805
4806
# File 'lib/models/porcelain.rb', line 4804

def password
  @password
end

#portObject

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



4806
4807
4808
# File 'lib/models/porcelain.rb', line 4806

def port
  @port
end

#port_overrideObject

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



4808
4809
4810
# File 'lib/models/porcelain.rb', line 4808

def port_override
  @port_override
end

#secret_store_idObject

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



4810
4811
4812
# File 'lib/models/porcelain.rb', line 4810

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



4812
4813
4814
# File 'lib/models/porcelain.rb', line 4812

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)



4814
4815
4816
# File 'lib/models/porcelain.rb', line 4814

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



4816
4817
4818
# File 'lib/models/porcelain.rb', line 4816

def tags
  @tags
end

#usernameObject

The username to authenticate with.



4818
4819
4820
# File 'lib/models/porcelain.rb', line 4818

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



4862
4863
4864
4865
4866
4867
4868
# File 'lib/models/porcelain.rb', line 4862

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