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.



5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
# File 'lib/models/porcelain.rb', line 5901

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.



5863
5864
5865
# File 'lib/models/porcelain.rb', line 5863

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5865
5866
5867
# File 'lib/models/porcelain.rb', line 5865

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5867
5868
5869
# File 'lib/models/porcelain.rb', line 5867

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5869
5870
5871
# File 'lib/models/porcelain.rb', line 5869

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.



5871
5872
5873
# File 'lib/models/porcelain.rb', line 5871

def database
  @database
end

#egress_filterObject

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



5873
5874
5875
# File 'lib/models/porcelain.rb', line 5873

def egress_filter
  @egress_filter
end

#healthyObject

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



5875
5876
5877
# File 'lib/models/porcelain.rb', line 5875

def healthy
  @healthy
end

#hostnameObject

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



5877
5878
5879
# File 'lib/models/porcelain.rb', line 5877

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5879
5880
5881
# File 'lib/models/porcelain.rb', line 5879

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5881
5882
5883
# File 'lib/models/porcelain.rb', line 5881

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.



5883
5884
5885
# File 'lib/models/porcelain.rb', line 5883

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5885
5886
5887
# File 'lib/models/porcelain.rb', line 5885

def password
  @password
end

#portObject

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



5887
5888
5889
# File 'lib/models/porcelain.rb', line 5887

def port
  @port
end

#port_overrideObject

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



5889
5890
5891
# File 'lib/models/porcelain.rb', line 5889

def port_override
  @port_override
end

#secret_store_idObject

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



5891
5892
5893
# File 'lib/models/porcelain.rb', line 5891

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5893
5894
5895
# File 'lib/models/porcelain.rb', line 5893

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)



5895
5896
5897
# File 'lib/models/porcelain.rb', line 5895

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5897
5898
5899
# File 'lib/models/porcelain.rb', line 5897

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5899
5900
5901
# File 'lib/models/porcelain.rb', line 5899

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5943
5944
5945
5946
5947
5948
5949
# File 'lib/models/porcelain.rb', line 5943

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