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.



10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
# File 'lib/models/porcelain.rb', line 10000

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



9960
9961
9962
# File 'lib/models/porcelain.rb', line 9960

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



9962
9963
9964
# File 'lib/models/porcelain.rb', line 9962

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



9964
9965
9966
# File 'lib/models/porcelain.rb', line 9964

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



9966
9967
9968
# File 'lib/models/porcelain.rb', line 9966

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.



9968
9969
9970
# File 'lib/models/porcelain.rb', line 9968

def database
  @database
end

#egress_filterObject

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



9970
9971
9972
# File 'lib/models/porcelain.rb', line 9970

def egress_filter
  @egress_filter
end

#healthyObject

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



9972
9973
9974
# File 'lib/models/porcelain.rb', line 9972

def healthy
  @healthy
end

#hostnameObject

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



9974
9975
9976
# File 'lib/models/porcelain.rb', line 9974

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9976
9977
9978
# File 'lib/models/porcelain.rb', line 9976

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



9978
9979
9980
# File 'lib/models/porcelain.rb', line 9978

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.



9980
9981
9982
# File 'lib/models/porcelain.rb', line 9980

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



9982
9983
9984
# File 'lib/models/porcelain.rb', line 9982

def password
  @password
end

#portObject

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



9984
9985
9986
# File 'lib/models/porcelain.rb', line 9984

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



9986
9987
9988
# File 'lib/models/porcelain.rb', line 9986

def port_override
  @port_override
end

#proxy_cluster_idObject

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



9988
9989
9990
# File 'lib/models/porcelain.rb', line 9988

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



9990
9991
9992
# File 'lib/models/porcelain.rb', line 9990

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



9992
9993
9994
# File 'lib/models/porcelain.rb', line 9992

def server_name
  @server_name
end

#subdomainObject

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



9994
9995
9996
# File 'lib/models/porcelain.rb', line 9994

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9996
9997
9998
# File 'lib/models/porcelain.rb', line 9996

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9998
9999
10000
# File 'lib/models/porcelain.rb', line 9998

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



10044
10045
10046
10047
10048
10049
10050
# File 'lib/models/porcelain.rb', line 10044

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