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.



9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
# File 'lib/models/porcelain.rb', line 9570

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.



9530
9531
9532
# File 'lib/models/porcelain.rb', line 9530

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.



9532
9533
9534
# File 'lib/models/porcelain.rb', line 9532

def bind_interface
  @bind_interface
end

#databaseObject

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



9534
9535
9536
# File 'lib/models/porcelain.rb', line 9534

def database
  @database
end

#egress_filterObject

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



9536
9537
9538
# File 'lib/models/porcelain.rb', line 9536

def egress_filter
  @egress_filter
end

#healthyObject

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



9538
9539
9540
# File 'lib/models/porcelain.rb', line 9538

def healthy
  @healthy
end

#hostnameObject

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



9540
9541
9542
# File 'lib/models/porcelain.rb', line 9540

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9542
9543
9544
# File 'lib/models/porcelain.rb', line 9542

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.



9544
9545
9546
# File 'lib/models/porcelain.rb', line 9544

def keytab
  @keytab
end

#krb_configObject

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



9546
9547
9548
# File 'lib/models/porcelain.rb', line 9546

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



9548
9549
9550
# File 'lib/models/porcelain.rb', line 9548

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.



9550
9551
9552
# File 'lib/models/porcelain.rb', line 9550

def override_database
  @override_database
end

#portObject

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



9552
9553
9554
# File 'lib/models/porcelain.rb', line 9552

def port
  @port
end

#port_overrideObject

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



9554
9555
9556
# File 'lib/models/porcelain.rb', line 9554

def port_override
  @port_override
end

#realmObject

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



9556
9557
9558
# File 'lib/models/porcelain.rb', line 9556

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



9558
9559
9560
# File 'lib/models/porcelain.rb', line 9558

def schema
  @schema
end

#secret_store_idObject

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



9560
9561
9562
# File 'lib/models/porcelain.rb', line 9560

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



9562
9563
9564
# File 'lib/models/porcelain.rb', line 9562

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)



9564
9565
9566
# File 'lib/models/porcelain.rb', line 9564

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9566
9567
9568
# File 'lib/models/porcelain.rb', line 9566

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9568
9569
9570
# File 'lib/models/porcelain.rb', line 9568

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9614
9615
9616
9617
9618
9619
9620
# File 'lib/models/porcelain.rb', line 9614

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