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.



5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
# File 'lib/models/porcelain.rb', line 5115

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.



5077
5078
5079
# File 'lib/models/porcelain.rb', line 5077

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5079
5080
5081
# File 'lib/models/porcelain.rb', line 5079

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5081
5082
5083
# File 'lib/models/porcelain.rb', line 5081

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5083
5084
5085
# File 'lib/models/porcelain.rb', line 5083

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.



5085
5086
5087
# File 'lib/models/porcelain.rb', line 5085

def database
  @database
end

#egress_filterObject

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



5087
5088
5089
# File 'lib/models/porcelain.rb', line 5087

def egress_filter
  @egress_filter
end

#healthyObject

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



5089
5090
5091
# File 'lib/models/porcelain.rb', line 5089

def healthy
  @healthy
end

#hostnameObject

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



5091
5092
5093
# File 'lib/models/porcelain.rb', line 5091

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5093
5094
5095
# File 'lib/models/porcelain.rb', line 5093

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5095
5096
5097
# File 'lib/models/porcelain.rb', line 5095

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.



5097
5098
5099
# File 'lib/models/porcelain.rb', line 5097

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5099
5100
5101
# File 'lib/models/porcelain.rb', line 5099

def password
  @password
end

#portObject

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



5101
5102
5103
# File 'lib/models/porcelain.rb', line 5101

def port
  @port
end

#port_overrideObject

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



5103
5104
5105
# File 'lib/models/porcelain.rb', line 5103

def port_override
  @port_override
end

#secret_store_idObject

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



5105
5106
5107
# File 'lib/models/porcelain.rb', line 5105

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5107
5108
5109
# File 'lib/models/porcelain.rb', line 5107

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)



5109
5110
5111
# File 'lib/models/porcelain.rb', line 5109

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5111
5112
5113
# File 'lib/models/porcelain.rb', line 5111

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5113
5114
5115
# File 'lib/models/porcelain.rb', line 5113

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5157
5158
5159
5160
5161
5162
5163
# File 'lib/models/porcelain.rb', line 5157

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