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.



8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
# File 'lib/models/porcelain.rb', line 8909

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.



8869
8870
8871
# File 'lib/models/porcelain.rb', line 8869

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.



8871
8872
8873
# File 'lib/models/porcelain.rb', line 8871

def bind_interface
  @bind_interface
end

#databaseObject

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



8873
8874
8875
# File 'lib/models/porcelain.rb', line 8873

def database
  @database
end

#egress_filterObject

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



8875
8876
8877
# File 'lib/models/porcelain.rb', line 8875

def egress_filter
  @egress_filter
end

#healthyObject

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



8877
8878
8879
# File 'lib/models/porcelain.rb', line 8877

def healthy
  @healthy
end

#hostnameObject

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



8879
8880
8881
# File 'lib/models/porcelain.rb', line 8879

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8881
8882
8883
# File 'lib/models/porcelain.rb', line 8881

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.



8883
8884
8885
# File 'lib/models/porcelain.rb', line 8883

def keytab
  @keytab
end

#krb_configObject

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



8885
8886
8887
# File 'lib/models/porcelain.rb', line 8885

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8887
8888
8889
# File 'lib/models/porcelain.rb', line 8887

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.



8889
8890
8891
# File 'lib/models/porcelain.rb', line 8889

def override_database
  @override_database
end

#portObject

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



8891
8892
8893
# File 'lib/models/porcelain.rb', line 8891

def port
  @port
end

#port_overrideObject

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



8893
8894
8895
# File 'lib/models/porcelain.rb', line 8893

def port_override
  @port_override
end

#realmObject

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



8895
8896
8897
# File 'lib/models/porcelain.rb', line 8895

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8897
8898
8899
# File 'lib/models/porcelain.rb', line 8897

def schema
  @schema
end

#secret_store_idObject

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



8899
8900
8901
# File 'lib/models/porcelain.rb', line 8899

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



8901
8902
8903
# File 'lib/models/porcelain.rb', line 8901

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)



8903
8904
8905
# File 'lib/models/porcelain.rb', line 8903

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8905
8906
8907
# File 'lib/models/porcelain.rb', line 8905

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8907
8908
8909
# File 'lib/models/porcelain.rb', line 8907

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8953
8954
8955
8956
8957
8958
8959
# File 'lib/models/porcelain.rb', line 8953

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