Class: SDM::SQLServerKerberosAD

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_encryption: nil, bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, keytab: nil, krb_config: nil, name: nil, override_database: nil, port: nil, port_override: nil, realm: nil, schema: nil, secret_store_id: nil, server_spn: nil, subdomain: nil, tags: nil, username: nil) ⇒ SQLServerKerberosAD

Returns a new instance of SQLServerKerberosAD.



8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
# File 'lib/models/porcelain.rb', line 8824

def initialize(
  allow_deprecated_encryption: nil,
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  keytab: nil,
  krb_config: nil,
  name: nil,
  override_database: nil,
  port: nil,
  port_override: nil,
  realm: nil,
  schema: nil,
  secret_store_id: nil,
  server_spn: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_encryption = allow_deprecated_encryption == nil ? false : allow_deprecated_encryption
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @keytab = keytab == nil ? "" : keytab
  @krb_config = krb_config == nil ? "" : krb_config
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @realm = realm == nil ? "" : realm
  @schema = schema == nil ? "" : schema
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_spn = server_spn == nil ? "" : server_spn
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_encryptionObject

Whether to allow deprecated encryption protocols to be used for this resource. For example, TLS 1.0.



8784
8785
8786
# File 'lib/models/porcelain.rb', line 8784

def allow_deprecated_encryption
  @allow_deprecated_encryption
end

#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.



8786
8787
8788
# File 'lib/models/porcelain.rb', line 8786

def bind_interface
  @bind_interface
end

#databaseObject

The database for healthchecks, and used for clients if Override Default Database is true.



8788
8789
8790
# File 'lib/models/porcelain.rb', line 8788

def database
  @database
end

#egress_filterObject

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



8790
8791
8792
# File 'lib/models/porcelain.rb', line 8790

def egress_filter
  @egress_filter
end

#healthyObject

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



8792
8793
8794
# File 'lib/models/porcelain.rb', line 8792

def healthy
  @healthy
end

#hostnameObject

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



8794
8795
8796
# File 'lib/models/porcelain.rb', line 8794

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8796
8797
8798
# File 'lib/models/porcelain.rb', line 8796

def id
  @id
end

#keytabObject

The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.



8798
8799
8800
# File 'lib/models/porcelain.rb', line 8798

def keytab
  @keytab
end

#krb_configObject

The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.



8800
8801
8802
# File 'lib/models/porcelain.rb', line 8800

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8802
8803
8804
# File 'lib/models/porcelain.rb', line 8802

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.



8804
8805
8806
# File 'lib/models/porcelain.rb', line 8804

def override_database
  @override_database
end

#portObject

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



8806
8807
8808
# File 'lib/models/porcelain.rb', line 8806

def port
  @port
end

#port_overrideObject

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



8808
8809
8810
# File 'lib/models/porcelain.rb', line 8808

def port_override
  @port_override
end

#realmObject

The Active Directory domain (realm) to which the configured username belongs.



8810
8811
8812
# File 'lib/models/porcelain.rb', line 8810

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8812
8813
8814
# File 'lib/models/porcelain.rb', line 8812

def schema
  @schema
end

#secret_store_idObject

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



8814
8815
8816
# File 'lib/models/porcelain.rb', line 8814

def secret_store_id
  @secret_store_id
end

#server_spnObject

The Service Principal Name of the Microsoft SQL Server instance in Active Directory.



8816
8817
8818
# File 'lib/models/porcelain.rb', line 8816

def server_spn
  @server_spn
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



8818
8819
8820
# File 'lib/models/porcelain.rb', line 8818

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8820
8821
8822
# File 'lib/models/porcelain.rb', line 8820

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8822
8823
8824
# File 'lib/models/porcelain.rb', line 8822

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8868
8869
8870
8871
8872
8873
8874
# File 'lib/models/porcelain.rb', line 8868

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