Class: SDM::MTLSMysql

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

MTLSMysql is currently unstable, and its API may change, or it may be removed, without a major version bump.

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, password: nil, port: nil, port_override: nil, require_native_auth: nil, secret_store_id: nil, server_name: nil, subdomain: nil, tags: nil, use_azure_single_server_usernames: nil, username: nil) ⇒ MTLSMysql

Returns a new instance of MTLSMysql.



5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
# File 'lib/models/porcelain.rb', line 5670

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,
  password: nil,
  port: nil,
  port_override: nil,
  require_native_auth: nil,
  secret_store_id: nil,
  server_name: nil,
  subdomain: nil,
  tags: nil,
  use_azure_single_server_usernames: 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
  @password = password == nil ? "" : password
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @require_native_auth = require_native_auth == nil ? false : require_native_auth
  @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
  @use_azure_single_server_usernames = use_azure_single_server_usernames == nil ? false : use_azure_single_server_usernames
  @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.



5630
5631
5632
# File 'lib/models/porcelain.rb', line 5630

def bind_interface
  @bind_interface
end

#certificate_authorityObject

The CA to authenticate TLS connections with.



5632
5633
5634
# File 'lib/models/porcelain.rb', line 5632

def certificate_authority
  @certificate_authority
end

#client_certificateObject

The certificate to authenticate TLS connections with.



5634
5635
5636
# File 'lib/models/porcelain.rb', line 5634

def client_certificate
  @client_certificate
end

#client_keyObject

The key to authenticate TLS connections with.



5636
5637
5638
# File 'lib/models/porcelain.rb', line 5636

def client_key
  @client_key
end

#databaseObject

The database for healthchecks. Does not affect client requests.



5638
5639
5640
# File 'lib/models/porcelain.rb', line 5638

def database
  @database
end

#egress_filterObject

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



5640
5641
5642
# File 'lib/models/porcelain.rb', line 5640

def egress_filter
  @egress_filter
end

#healthyObject

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



5642
5643
5644
# File 'lib/models/porcelain.rb', line 5642

def healthy
  @healthy
end

#hostnameObject

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



5644
5645
5646
# File 'lib/models/porcelain.rb', line 5644

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5646
5647
5648
# File 'lib/models/porcelain.rb', line 5646

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5648
5649
5650
# File 'lib/models/porcelain.rb', line 5648

def name
  @name
end

#passwordObject

The password to authenticate with.



5650
5651
5652
# File 'lib/models/porcelain.rb', line 5650

def password
  @password
end

#portObject

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



5652
5653
5654
# File 'lib/models/porcelain.rb', line 5652

def port
  @port
end

#port_overrideObject

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



5654
5655
5656
# File 'lib/models/porcelain.rb', line 5654

def port_override
  @port_override
end

#require_native_authObject

Whether native auth (mysql_native_password) is used for all connections (for backwards compatibility)



5656
5657
5658
# File 'lib/models/porcelain.rb', line 5656

def require_native_auth
  @require_native_auth
end

#secret_store_idObject

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



5658
5659
5660
# File 'lib/models/porcelain.rb', line 5658

def secret_store_id
  @secret_store_id
end

#server_nameObject

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



5660
5661
5662
# File 'lib/models/porcelain.rb', line 5660

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)



5662
5663
5664
# File 'lib/models/porcelain.rb', line 5662

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5664
5665
5666
# File 'lib/models/porcelain.rb', line 5664

def tags
  @tags
end

#use_azure_single_server_usernamesObject

If true, appends the hostname to the username when hitting a database.azure.com address



5666
5667
5668
# File 'lib/models/porcelain.rb', line 5666

def use_azure_single_server_usernames
  @use_azure_single_server_usernames
end

#usernameObject

The username to authenticate with.



5668
5669
5670
# File 'lib/models/porcelain.rb', line 5668

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5714
5715
5716
5717
5718
5719
5720
# File 'lib/models/porcelain.rb', line 5714

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