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.



6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
# File 'lib/models/porcelain.rb', line 6157

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.



6119
6120
6121
# File 'lib/models/porcelain.rb', line 6119

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



6121
6122
6123
# File 'lib/models/porcelain.rb', line 6121

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



6123
6124
6125
# File 'lib/models/porcelain.rb', line 6123

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



6125
6126
6127
# File 'lib/models/porcelain.rb', line 6125

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.



6127
6128
6129
# File 'lib/models/porcelain.rb', line 6127

def database
  @database
end

#egress_filterObject

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



6129
6130
6131
# File 'lib/models/porcelain.rb', line 6129

def egress_filter
  @egress_filter
end

#healthyObject

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



6131
6132
6133
# File 'lib/models/porcelain.rb', line 6131

def healthy
  @healthy
end

#hostnameObject

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



6133
6134
6135
# File 'lib/models/porcelain.rb', line 6133

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6135
6136
6137
# File 'lib/models/porcelain.rb', line 6135

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6137
6138
6139
# File 'lib/models/porcelain.rb', line 6137

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.



6139
6140
6141
# File 'lib/models/porcelain.rb', line 6139

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



6141
6142
6143
# File 'lib/models/porcelain.rb', line 6141

def password
  @password
end

#portObject

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



6143
6144
6145
# File 'lib/models/porcelain.rb', line 6143

def port
  @port
end

#port_overrideObject

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



6145
6146
6147
# File 'lib/models/porcelain.rb', line 6145

def port_override
  @port_override
end

#secret_store_idObject

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



6147
6148
6149
# File 'lib/models/porcelain.rb', line 6147

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



6149
6150
6151
# File 'lib/models/porcelain.rb', line 6149

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)



6151
6152
6153
# File 'lib/models/porcelain.rb', line 6151

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6153
6154
6155
# File 'lib/models/porcelain.rb', line 6153

def tags
  @tags
end

#usernameObject

The username to authenticate with.



6155
6156
6157
# File 'lib/models/porcelain.rb', line 6155

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6199
6200
6201
6202
6203
6204
6205
# File 'lib/models/porcelain.rb', line 6199

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