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.



5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
# File 'lib/models/porcelain.rb', line 5836

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.



5798
5799
5800
# File 'lib/models/porcelain.rb', line 5798

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5800
5801
5802
# File 'lib/models/porcelain.rb', line 5800

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5802
5803
5804
# File 'lib/models/porcelain.rb', line 5802

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5804
5805
5806
# File 'lib/models/porcelain.rb', line 5804

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.



5806
5807
5808
# File 'lib/models/porcelain.rb', line 5806

def database
  @database
end

#egress_filterObject

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



5808
5809
5810
# File 'lib/models/porcelain.rb', line 5808

def egress_filter
  @egress_filter
end

#healthyObject

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



5810
5811
5812
# File 'lib/models/porcelain.rb', line 5810

def healthy
  @healthy
end

#hostnameObject

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



5812
5813
5814
# File 'lib/models/porcelain.rb', line 5812

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5814
5815
5816
# File 'lib/models/porcelain.rb', line 5814

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5816
5817
5818
# File 'lib/models/porcelain.rb', line 5816

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.



5818
5819
5820
# File 'lib/models/porcelain.rb', line 5818

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



5820
5821
5822
# File 'lib/models/porcelain.rb', line 5820

def password
  @password
end

#portObject

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



5822
5823
5824
# File 'lib/models/porcelain.rb', line 5822

def port
  @port
end

#port_overrideObject

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



5824
5825
5826
# File 'lib/models/porcelain.rb', line 5824

def port_override
  @port_override
end

#secret_store_idObject

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



5826
5827
5828
# File 'lib/models/porcelain.rb', line 5826

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5828
5829
5830
# File 'lib/models/porcelain.rb', line 5828

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)



5830
5831
5832
# File 'lib/models/porcelain.rb', line 5830

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5832
5833
5834
# File 'lib/models/porcelain.rb', line 5832

def tags
  @tags
end

#usernameObject

The username to authenticate with.



5834
5835
5836
# File 'lib/models/porcelain.rb', line 5834

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5878
5879
5880
5881
5882
5883
5884
# File 'lib/models/porcelain.rb', line 5878

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