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.



5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
 
# File 'lib/models/porcelain.rb', line 5159

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.



5121
5122
5123
 
# File 'lib/models/porcelain.rb', line 5121

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



5123
5124
5125
 
# File 'lib/models/porcelain.rb', line 5123

def certificate_authority
  @certificate_authority
end

#client_certificate ⇒ Object

The certificate to authenticate TLS connections with.



5125
5126
5127
 
# File 'lib/models/porcelain.rb', line 5125

def client_certificate
  @client_certificate
end

#client_key ⇒ Object

The key to authenticate TLS connections with.



5127
5128
5129
 
# File 'lib/models/porcelain.rb', line 5127

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.



5129
5130
5131
 
# File 'lib/models/porcelain.rb', line 5129

def database
  @database
end

#egress_filter ⇒ Object

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



5131
5132
5133
 
# File 'lib/models/porcelain.rb', line 5131

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



5133
5134
5135
 
# File 'lib/models/porcelain.rb', line 5133

def healthy
  @healthy
end

#hostname ⇒ Object

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



5135
5136
5137
 
# File 'lib/models/porcelain.rb', line 5135

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



5137
5138
5139
 
# File 'lib/models/porcelain.rb', line 5137

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



5139
5140
5141
 
# File 'lib/models/porcelain.rb', line 5139

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.



5141
5142
5143
 
# File 'lib/models/porcelain.rb', line 5141

def override_database
  @override_database
end

#password ⇒ Object

The password to authenticate with.



5143
5144
5145
 
# File 'lib/models/porcelain.rb', line 5143

def password
  @password
end

#port ⇒ Object

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



5145
5146
5147
 
# File 'lib/models/porcelain.rb', line 5145

def port
  @port
end

#port_override ⇒ Object

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



5147
5148
5149
 
# File 'lib/models/porcelain.rb', line 5147

def port_override
  @port_override
end

#secret_store_id ⇒ Object

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



5149
5150
5151
 
# File 'lib/models/porcelain.rb', line 5149

def secret_store_id
  @secret_store_id
end

#server_name ⇒ Object

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



5151
5152
5153
 
# File 'lib/models/porcelain.rb', line 5151

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)



5153
5154
5155
 
# File 'lib/models/porcelain.rb', line 5153

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



5155
5156
5157
 
# File 'lib/models/porcelain.rb', line 5155

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



5157
5158
5159
 
# File 'lib/models/porcelain.rb', line 5157

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5201
5202
5203
5204
5205
5206
5207
 
# File 'lib/models/porcelain.rb', line 5201

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