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



9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
# File 'lib/models/porcelain.rb', line 9905

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.



9865
9866
9867
# File 'lib/models/porcelain.rb', line 9865

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



9867
9868
9869
# File 'lib/models/porcelain.rb', line 9867

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



9869
9870
9871
# File 'lib/models/porcelain.rb', line 9869

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



9871
9872
9873
# File 'lib/models/porcelain.rb', line 9871

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.



9873
9874
9875
# File 'lib/models/porcelain.rb', line 9873

def database
  @database
end

#egress_filterObject

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



9875
9876
9877
# File 'lib/models/porcelain.rb', line 9875

def egress_filter
  @egress_filter
end

#healthyObject

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



9877
9878
9879
# File 'lib/models/porcelain.rb', line 9877

def healthy
  @healthy
end

#hostnameObject

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



9879
9880
9881
# File 'lib/models/porcelain.rb', line 9879

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9881
9882
9883
# File 'lib/models/porcelain.rb', line 9881

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



9883
9884
9885
# File 'lib/models/porcelain.rb', line 9883

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.



9885
9886
9887
# File 'lib/models/porcelain.rb', line 9885

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



9887
9888
9889
# File 'lib/models/porcelain.rb', line 9887

def password
  @password
end

#portObject

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



9889
9890
9891
# File 'lib/models/porcelain.rb', line 9889

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.



9891
9892
9893
# File 'lib/models/porcelain.rb', line 9891

def port_override
  @port_override
end

#proxy_cluster_idObject

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



9893
9894
9895
# File 'lib/models/porcelain.rb', line 9893

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



9895
9896
9897
# File 'lib/models/porcelain.rb', line 9895

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



9897
9898
9899
# File 'lib/models/porcelain.rb', line 9897

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.



9899
9900
9901
# File 'lib/models/porcelain.rb', line 9899

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9901
9902
9903
# File 'lib/models/porcelain.rb', line 9901

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9903
9904
9905
# File 'lib/models/porcelain.rb', line 9903

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9949
9950
9951
9952
9953
9954
9955
# File 'lib/models/porcelain.rb', line 9949

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