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.



5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
 
# File 'lib/models/porcelain.rb', line 5207

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_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.



5169
5170
5171
 
# File 'lib/models/porcelain.rb', line 5169

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



5171
5172
5173
 
# File 'lib/models/porcelain.rb', line 5171

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



5173
5174
5175
 
# File 'lib/models/porcelain.rb', line 5173

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



5175
5176
5177
 
# File 'lib/models/porcelain.rb', line 5175

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.



5177
5178
5179
 
# File 'lib/models/porcelain.rb', line 5177

def database
  @database
end

#egress_filter ⇒ Object

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



5179
5180
5181
 
# File 'lib/models/porcelain.rb', line 5179

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



5181
5182
5183
 
# File 'lib/models/porcelain.rb', line 5181

def healthy
  @healthy
end

#hostname ⇒ Object

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



5183
5184
5185
 
# File 'lib/models/porcelain.rb', line 5183

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



5185
5186
5187
 
# File 'lib/models/porcelain.rb', line 5185

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



5187
5188
5189
 
# File 'lib/models/porcelain.rb', line 5187

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.



5189
5190
5191
 
# File 'lib/models/porcelain.rb', line 5189

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



5191
5192
5193
 
# File 'lib/models/porcelain.rb', line 5191

def password
  @password
end

#port ⇒ Object

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



5193
5194
5195
 
# File 'lib/models/porcelain.rb', line 5193

def port
  @port
end

#port_override ⇒ Object

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



5195
5196
5197
 
# File 'lib/models/porcelain.rb', line 5195

def port_override
  @port_override
end

#secret_store_id ⇒ Object

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



5197
5198
5199
 
# File 'lib/models/porcelain.rb', line 5197

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



5199
5200
5201
 
# File 'lib/models/porcelain.rb', line 5199

def server_name
  @server_name
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



5201
5202
5203
 
# File 'lib/models/porcelain.rb', line 5201

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



5203
5204
5205
 
# File 'lib/models/porcelain.rb', line 5203

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



5205
5206
5207
 
# File 'lib/models/porcelain.rb', line 5205

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5249
5250
5251
5252
5253
5254
5255
 
# File 'lib/models/porcelain.rb', line 5249

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