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.



7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
# File 'lib/models/porcelain.rb', line 7997

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.



7957
7958
7959
# File 'lib/models/porcelain.rb', line 7957

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



7959
7960
7961
# File 'lib/models/porcelain.rb', line 7959

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



7961
7962
7963
# File 'lib/models/porcelain.rb', line 7961

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



7963
7964
7965
# File 'lib/models/porcelain.rb', line 7963

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.



7965
7966
7967
# File 'lib/models/porcelain.rb', line 7965

def database
  @database
end

#egress_filterObject

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



7967
7968
7969
# File 'lib/models/porcelain.rb', line 7967

def egress_filter
  @egress_filter
end

#healthyObject

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



7969
7970
7971
# File 'lib/models/porcelain.rb', line 7969

def healthy
  @healthy
end

#hostnameObject

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



7971
7972
7973
# File 'lib/models/porcelain.rb', line 7971

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7973
7974
7975
# File 'lib/models/porcelain.rb', line 7973

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



7975
7976
7977
# File 'lib/models/porcelain.rb', line 7975

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.



7977
7978
7979
# File 'lib/models/porcelain.rb', line 7977

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



7979
7980
7981
# File 'lib/models/porcelain.rb', line 7979

def password
  @password
end

#portObject

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



7981
7982
7983
# File 'lib/models/porcelain.rb', line 7981

def port
  @port
end

#port_overrideObject

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



7983
7984
7985
# File 'lib/models/porcelain.rb', line 7983

def port_override
  @port_override
end

#proxy_cluster_idObject

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



7985
7986
7987
# File 'lib/models/porcelain.rb', line 7985

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



7987
7988
7989
# File 'lib/models/porcelain.rb', line 7987

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



7989
7990
7991
# File 'lib/models/porcelain.rb', line 7989

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)



7991
7992
7993
# File 'lib/models/porcelain.rb', line 7991

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7993
7994
7995
# File 'lib/models/porcelain.rb', line 7993

def tags
  @tags
end

#usernameObject

The username to authenticate with.



7995
7996
7997
# File 'lib/models/porcelain.rb', line 7995

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8041
8042
8043
8044
8045
8046
8047
# File 'lib/models/porcelain.rb', line 8041

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