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, proxy_cluster_id: 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.



13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
# File 'lib/models/porcelain.rb', line 13413

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



13371
13372
13373
# File 'lib/models/porcelain.rb', line 13371

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.



13373
13374
13375
# File 'lib/models/porcelain.rb', line 13373

def bind_interface
  @bind_interface
end

#databaseObject

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



13375
13376
13377
# File 'lib/models/porcelain.rb', line 13375

def database
  @database
end

#egress_filterObject

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



13377
13378
13379
# File 'lib/models/porcelain.rb', line 13377

def egress_filter
  @egress_filter
end

#healthyObject

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



13379
13380
13381
# File 'lib/models/porcelain.rb', line 13379

def healthy
  @healthy
end

#hostnameObject

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



13381
13382
13383
# File 'lib/models/porcelain.rb', line 13381

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



13383
13384
13385
# File 'lib/models/porcelain.rb', line 13383

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.



13385
13386
13387
# File 'lib/models/porcelain.rb', line 13385

def keytab
  @keytab
end

#krb_configObject

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



13387
13388
13389
# File 'lib/models/porcelain.rb', line 13387

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



13389
13390
13391
# File 'lib/models/porcelain.rb', line 13389

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.



13391
13392
13393
# File 'lib/models/porcelain.rb', line 13391

def override_database
  @override_database
end

#portObject

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



13393
13394
13395
# File 'lib/models/porcelain.rb', line 13393

def port
  @port
end

#port_overrideObject

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



13395
13396
13397
# File 'lib/models/porcelain.rb', line 13395

def port_override
  @port_override
end

#proxy_cluster_idObject

ID of the proxy cluster for this resource, if any.



13397
13398
13399
# File 'lib/models/porcelain.rb', line 13397

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

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



13399
13400
13401
# File 'lib/models/porcelain.rb', line 13399

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



13401
13402
13403
# File 'lib/models/porcelain.rb', line 13401

def schema
  @schema
end

#secret_store_idObject

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



13403
13404
13405
# File 'lib/models/porcelain.rb', line 13403

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



13405
13406
13407
# File 'lib/models/porcelain.rb', line 13405

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)



13407
13408
13409
# File 'lib/models/porcelain.rb', line 13407

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



13409
13410
13411
# File 'lib/models/porcelain.rb', line 13409

def tags
  @tags
end

#usernameObject

The username to authenticate with.



13411
13412
13413
# File 'lib/models/porcelain.rb', line 13411

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



13459
13460
13461
13462
13463
13464
13465
# File 'lib/models/porcelain.rb', line 13459

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