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, proxy_cluster_id: nil, secret_store_id: nil, server_name: nil, subdomain: nil, tags: nil, username: nil) ⇒ MTLSPostgres

Returns a new instance of MTLSPostgres.



8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
# File 'lib/models/porcelain.rb', line 8152

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



8112
8113
8114
# File 'lib/models/porcelain.rb', line 8112

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



8114
8115
8116
# File 'lib/models/porcelain.rb', line 8114

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



8116
8117
8118
# File 'lib/models/porcelain.rb', line 8116

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



8118
8119
8120
# File 'lib/models/porcelain.rb', line 8118

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.



8120
8121
8122
# File 'lib/models/porcelain.rb', line 8120

def database
  @database
end

#egress_filterObject

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



8122
8123
8124
# File 'lib/models/porcelain.rb', line 8122

def egress_filter
  @egress_filter
end

#healthyObject

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



8124
8125
8126
# File 'lib/models/porcelain.rb', line 8124

def healthy
  @healthy
end

#hostnameObject

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



8126
8127
8128
# File 'lib/models/porcelain.rb', line 8126

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8128
8129
8130
# File 'lib/models/porcelain.rb', line 8128

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



8130
8131
8132
# File 'lib/models/porcelain.rb', line 8130

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.



8132
8133
8134
# File 'lib/models/porcelain.rb', line 8132

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



8134
8135
8136
# File 'lib/models/porcelain.rb', line 8134

def password
  @password
end

#portObject

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



8136
8137
8138
# File 'lib/models/porcelain.rb', line 8136

def port
  @port
end

#port_overrideObject

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



8138
8139
8140
# File 'lib/models/porcelain.rb', line 8138

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



8140
8141
8142
# File 'lib/models/porcelain.rb', line 8140

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



8142
8143
8144
# File 'lib/models/porcelain.rb', line 8142

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



8144
8145
8146
# File 'lib/models/porcelain.rb', line 8144

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)



8146
8147
8148
# File 'lib/models/porcelain.rb', line 8146

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8148
8149
8150
# File 'lib/models/porcelain.rb', line 8148

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8150
8151
8152
# File 'lib/models/porcelain.rb', line 8150

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8196
8197
8198
8199
8200
8201
8202
# File 'lib/models/porcelain.rb', line 8196

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