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.



8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
# File 'lib/models/porcelain.rb', line 8709

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.



8669
8670
8671
# File 'lib/models/porcelain.rb', line 8669

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.



8671
8672
8673
# File 'lib/models/porcelain.rb', line 8671

def bind_interface
  @bind_interface
end

#databaseObject

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



8673
8674
8675
# File 'lib/models/porcelain.rb', line 8673

def database
  @database
end

#egress_filterObject

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



8675
8676
8677
# File 'lib/models/porcelain.rb', line 8675

def egress_filter
  @egress_filter
end

#healthyObject

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



8677
8678
8679
# File 'lib/models/porcelain.rb', line 8677

def healthy
  @healthy
end

#hostnameObject

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



8679
8680
8681
# File 'lib/models/porcelain.rb', line 8679

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8681
8682
8683
# File 'lib/models/porcelain.rb', line 8681

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.



8683
8684
8685
# File 'lib/models/porcelain.rb', line 8683

def keytab
  @keytab
end

#krb_configObject

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



8685
8686
8687
# File 'lib/models/porcelain.rb', line 8685

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8687
8688
8689
# File 'lib/models/porcelain.rb', line 8687

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.



8689
8690
8691
# File 'lib/models/porcelain.rb', line 8689

def override_database
  @override_database
end

#portObject

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



8691
8692
8693
# File 'lib/models/porcelain.rb', line 8691

def port
  @port
end

#port_overrideObject

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



8693
8694
8695
# File 'lib/models/porcelain.rb', line 8693

def port_override
  @port_override
end

#realmObject

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



8695
8696
8697
# File 'lib/models/porcelain.rb', line 8695

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8697
8698
8699
# File 'lib/models/porcelain.rb', line 8697

def schema
  @schema
end

#secret_store_idObject

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



8699
8700
8701
# File 'lib/models/porcelain.rb', line 8699

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



8701
8702
8703
# File 'lib/models/porcelain.rb', line 8701

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)



8703
8704
8705
# File 'lib/models/porcelain.rb', line 8703

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8705
8706
8707
# File 'lib/models/porcelain.rb', line 8705

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8707
8708
8709
# File 'lib/models/porcelain.rb', line 8707

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8753
8754
8755
8756
8757
8758
8759
# File 'lib/models/porcelain.rb', line 8753

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