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.



8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
# File 'lib/models/porcelain.rb', line 8634

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.



8594
8595
8596
# File 'lib/models/porcelain.rb', line 8594

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.



8596
8597
8598
# File 'lib/models/porcelain.rb', line 8596

def bind_interface
  @bind_interface
end

#databaseObject

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



8598
8599
8600
# File 'lib/models/porcelain.rb', line 8598

def database
  @database
end

#egress_filterObject

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



8600
8601
8602
# File 'lib/models/porcelain.rb', line 8600

def egress_filter
  @egress_filter
end

#healthyObject

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



8602
8603
8604
# File 'lib/models/porcelain.rb', line 8602

def healthy
  @healthy
end

#hostnameObject

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



8604
8605
8606
# File 'lib/models/porcelain.rb', line 8604

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8606
8607
8608
# File 'lib/models/porcelain.rb', line 8606

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.



8608
8609
8610
# File 'lib/models/porcelain.rb', line 8608

def keytab
  @keytab
end

#krb_configObject

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



8610
8611
8612
# File 'lib/models/porcelain.rb', line 8610

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8612
8613
8614
# File 'lib/models/porcelain.rb', line 8612

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.



8614
8615
8616
# File 'lib/models/porcelain.rb', line 8614

def override_database
  @override_database
end

#portObject

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



8616
8617
8618
# File 'lib/models/porcelain.rb', line 8616

def port
  @port
end

#port_overrideObject

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



8618
8619
8620
# File 'lib/models/porcelain.rb', line 8618

def port_override
  @port_override
end

#realmObject

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



8620
8621
8622
# File 'lib/models/porcelain.rb', line 8620

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8622
8623
8624
# File 'lib/models/porcelain.rb', line 8622

def schema
  @schema
end

#secret_store_idObject

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



8624
8625
8626
# File 'lib/models/porcelain.rb', line 8624

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



8626
8627
8628
# File 'lib/models/porcelain.rb', line 8626

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)



8628
8629
8630
# File 'lib/models/porcelain.rb', line 8628

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8630
8631
8632
# File 'lib/models/porcelain.rb', line 8630

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8632
8633
8634
# File 'lib/models/porcelain.rb', line 8632

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8678
8679
8680
8681
8682
8683
8684
# File 'lib/models/porcelain.rb', line 8678

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