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.



8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
# File 'lib/models/porcelain.rb', line 8490

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.



8450
8451
8452
# File 'lib/models/porcelain.rb', line 8450

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



8452
8453
8454
# File 'lib/models/porcelain.rb', line 8452

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



8454
8455
8456
# File 'lib/models/porcelain.rb', line 8454

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



8456
8457
8458
# File 'lib/models/porcelain.rb', line 8456

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.



8458
8459
8460
# File 'lib/models/porcelain.rb', line 8458

def database
  @database
end

#egress_filterObject

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



8460
8461
8462
# File 'lib/models/porcelain.rb', line 8460

def egress_filter
  @egress_filter
end

#healthyObject

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



8462
8463
8464
# File 'lib/models/porcelain.rb', line 8462

def healthy
  @healthy
end

#hostnameObject

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



8464
8465
8466
# File 'lib/models/porcelain.rb', line 8464

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8466
8467
8468
# File 'lib/models/porcelain.rb', line 8466

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



8468
8469
8470
# File 'lib/models/porcelain.rb', line 8468

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.



8470
8471
8472
# File 'lib/models/porcelain.rb', line 8470

def override_database
  @override_database
end

#passwordObject

The password to authenticate with.



8472
8473
8474
# File 'lib/models/porcelain.rb', line 8472

def password
  @password
end

#portObject

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



8474
8475
8476
# File 'lib/models/porcelain.rb', line 8474

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.



8476
8477
8478
# File 'lib/models/porcelain.rb', line 8476

def port_override
  @port_override
end

#proxy_cluster_idObject

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



8478
8479
8480
# File 'lib/models/porcelain.rb', line 8478

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_idObject

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



8480
8481
8482
# File 'lib/models/porcelain.rb', line 8480

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



8482
8483
8484
# File 'lib/models/porcelain.rb', line 8482

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)



8484
8485
8486
# File 'lib/models/porcelain.rb', line 8484

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8486
8487
8488
# File 'lib/models/porcelain.rb', line 8486

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8488
8489
8490
# File 'lib/models/porcelain.rb', line 8488

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8534
8535
8536
8537
8538
8539
8540
# File 'lib/models/porcelain.rb', line 8534

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