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.



5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
# File 'lib/models/porcelain.rb', line 5049

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.



5011
5012
5013
# File 'lib/models/porcelain.rb', line 5011

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5013
5014
5015
# File 'lib/models/porcelain.rb', line 5013

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5015
5016
5017
# File 'lib/models/porcelain.rb', line 5015

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5017
5018
5019
# File 'lib/models/porcelain.rb', line 5017

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.



5019
5020
5021
# File 'lib/models/porcelain.rb', line 5019

def database
  @database
end

#egress_filterObject

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



5021
5022
5023
# File 'lib/models/porcelain.rb', line 5021

def egress_filter
  @egress_filter
end

#healthyObject

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



5023
5024
5025
# File 'lib/models/porcelain.rb', line 5023

def healthy
  @healthy
end

#hostnameObject

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



5025
5026
5027
# File 'lib/models/porcelain.rb', line 5025

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5027
5028
5029
# File 'lib/models/porcelain.rb', line 5027

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5029
5030
5031
# File 'lib/models/porcelain.rb', line 5029

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.



5031
5032
5033
# File 'lib/models/porcelain.rb', line 5031

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5033
5034
5035
# File 'lib/models/porcelain.rb', line 5033

def password
  @password
end

#portObject

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



5035
5036
5037
# File 'lib/models/porcelain.rb', line 5035

def port
  @port
end

#port_overrideObject

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



5037
5038
5039
# File 'lib/models/porcelain.rb', line 5037

def port_override
  @port_override
end

#secret_store_idObject

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



5039
5040
5041
# File 'lib/models/porcelain.rb', line 5039

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5041
5042
5043
# File 'lib/models/porcelain.rb', line 5041

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)



5043
5044
5045
# File 'lib/models/porcelain.rb', line 5043

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5045
5046
5047
# File 'lib/models/porcelain.rb', line 5045

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5047
5048
5049
# File 'lib/models/porcelain.rb', line 5047

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5091
5092
5093
5094
5095
5096
5097
# File 'lib/models/porcelain.rb', line 5091

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