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



14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
# File 'lib/models/porcelain.rb', line 14534

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.



14492
14493
14494
# File 'lib/models/porcelain.rb', line 14492

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



14494
14495
14496
# File 'lib/models/porcelain.rb', line 14494

def bind_interface
  @bind_interface
end

#databaseObject

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



14496
14497
14498
# File 'lib/models/porcelain.rb', line 14496

def database
  @database
end

#egress_filterObject

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



14498
14499
14500
# File 'lib/models/porcelain.rb', line 14498

def egress_filter
  @egress_filter
end

#healthyObject

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



14500
14501
14502
# File 'lib/models/porcelain.rb', line 14500

def healthy
  @healthy
end

#hostnameObject

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



14502
14503
14504
# File 'lib/models/porcelain.rb', line 14502

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



14504
14505
14506
# File 'lib/models/porcelain.rb', line 14504

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.



14506
14507
14508
# File 'lib/models/porcelain.rb', line 14506

def keytab
  @keytab
end

#krb_configObject

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



14508
14509
14510
# File 'lib/models/porcelain.rb', line 14508

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



14510
14511
14512
# File 'lib/models/porcelain.rb', line 14510

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.



14512
14513
14514
# File 'lib/models/porcelain.rb', line 14512

def override_database
  @override_database
end

#portObject

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



14514
14515
14516
# File 'lib/models/porcelain.rb', line 14514

def port
  @port
end

#port_overrideObject

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



14516
14517
14518
# File 'lib/models/porcelain.rb', line 14516

def port_override
  @port_override
end

#proxy_cluster_idObject

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



14518
14519
14520
# File 'lib/models/porcelain.rb', line 14518

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

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



14520
14521
14522
# File 'lib/models/porcelain.rb', line 14520

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



14522
14523
14524
# File 'lib/models/porcelain.rb', line 14522

def schema
  @schema
end

#secret_store_idObject

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



14524
14525
14526
# File 'lib/models/porcelain.rb', line 14524

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



14526
14527
14528
# File 'lib/models/porcelain.rb', line 14526

def server_spn
  @server_spn
end

#subdomainObject

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



14528
14529
14530
# File 'lib/models/porcelain.rb', line 14528

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



14530
14531
14532
# File 'lib/models/porcelain.rb', line 14530

def tags
  @tags
end

#usernameObject

The username to authenticate with.



14532
14533
14534
# File 'lib/models/porcelain.rb', line 14532

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



14580
14581
14582
14583
14584
14585
14586
# File 'lib/models/porcelain.rb', line 14580

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