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.



6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
# File 'lib/models/porcelain.rb', line 6701

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.



6661
6662
6663
# File 'lib/models/porcelain.rb', line 6661

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



6663
6664
6665
# File 'lib/models/porcelain.rb', line 6663

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



6665
6666
6667
# File 'lib/models/porcelain.rb', line 6665

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



6667
6668
6669
# File 'lib/models/porcelain.rb', line 6667

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.



6669
6670
6671
# File 'lib/models/porcelain.rb', line 6669

def database
  @database
end

#egress_filterObject

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



6671
6672
6673
# File 'lib/models/porcelain.rb', line 6671

def egress_filter
  @egress_filter
end

#healthyObject

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



6673
6674
6675
# File 'lib/models/porcelain.rb', line 6673

def healthy
  @healthy
end

#hostnameObject

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



6675
6676
6677
# File 'lib/models/porcelain.rb', line 6675

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6677
6678
6679
# File 'lib/models/porcelain.rb', line 6677

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6679
6680
6681
# File 'lib/models/porcelain.rb', line 6679

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.



6681
6682
6683
# File 'lib/models/porcelain.rb', line 6681

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



6683
6684
6685
# File 'lib/models/porcelain.rb', line 6683

def password
  @password
end

#portObject

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



6685
6686
6687
# File 'lib/models/porcelain.rb', line 6685

def port
  @port
end

#port_overrideObject

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



6687
6688
6689
# File 'lib/models/porcelain.rb', line 6687

def port_override
  @port_override
end

#proxy_cluster_idObject

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



6689
6690
6691
# File 'lib/models/porcelain.rb', line 6689

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



6691
6692
6693
# File 'lib/models/porcelain.rb', line 6691

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



6693
6694
6695
# File 'lib/models/porcelain.rb', line 6693

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)



6695
6696
6697
# File 'lib/models/porcelain.rb', line 6695

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6697
6698
6699
# File 'lib/models/porcelain.rb', line 6697

def tags
  @tags
end

#usernameObject

The username to authenticate with.



6699
6700
6701
# File 'lib/models/porcelain.rb', line 6699

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6745
6746
6747
6748
6749
6750
6751
# File 'lib/models/porcelain.rb', line 6745

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