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.



8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
# File 'lib/models/porcelain.rb', line 8398

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.



8358
8359
8360
# File 'lib/models/porcelain.rb', line 8358

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.



8360
8361
8362
# File 'lib/models/porcelain.rb', line 8360

def bind_interface
  @bind_interface
end

#databaseObject

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



8362
8363
8364
# File 'lib/models/porcelain.rb', line 8362

def database
  @database
end

#egress_filterObject

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



8364
8365
8366
# File 'lib/models/porcelain.rb', line 8364

def egress_filter
  @egress_filter
end

#healthyObject

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



8366
8367
8368
# File 'lib/models/porcelain.rb', line 8366

def healthy
  @healthy
end

#hostnameObject

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



8368
8369
8370
# File 'lib/models/porcelain.rb', line 8368

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



8370
8371
8372
# File 'lib/models/porcelain.rb', line 8370

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.



8372
8373
8374
# File 'lib/models/porcelain.rb', line 8372

def keytab
  @keytab
end

#krb_configObject

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



8374
8375
8376
# File 'lib/models/porcelain.rb', line 8374

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



8376
8377
8378
# File 'lib/models/porcelain.rb', line 8376

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.



8378
8379
8380
# File 'lib/models/porcelain.rb', line 8378

def override_database
  @override_database
end

#portObject

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



8380
8381
8382
# File 'lib/models/porcelain.rb', line 8380

def port
  @port
end

#port_overrideObject

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



8382
8383
8384
# File 'lib/models/porcelain.rb', line 8382

def port_override
  @port_override
end

#realmObject

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



8384
8385
8386
# File 'lib/models/porcelain.rb', line 8384

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



8386
8387
8388
# File 'lib/models/porcelain.rb', line 8386

def schema
  @schema
end

#secret_store_idObject

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



8388
8389
8390
# File 'lib/models/porcelain.rb', line 8388

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



8390
8391
8392
# File 'lib/models/porcelain.rb', line 8390

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)



8392
8393
8394
# File 'lib/models/porcelain.rb', line 8392

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



8394
8395
8396
# File 'lib/models/porcelain.rb', line 8394

def tags
  @tags
end

#usernameObject

The username to authenticate with.



8396
8397
8398
# File 'lib/models/porcelain.rb', line 8396

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



8442
8443
8444
8445
8446
8447
8448
# File 'lib/models/porcelain.rb', line 8442

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