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



15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
# File 'lib/models/porcelain.rb', line 15286

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.



15244
15245
15246
# File 'lib/models/porcelain.rb', line 15244

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.



15246
15247
15248
# File 'lib/models/porcelain.rb', line 15246

def bind_interface
  @bind_interface
end

#databaseObject

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



15248
15249
15250
# File 'lib/models/porcelain.rb', line 15248

def database
  @database
end

#egress_filterObject

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



15250
15251
15252
# File 'lib/models/porcelain.rb', line 15250

def egress_filter
  @egress_filter
end

#healthyObject

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



15252
15253
15254
# File 'lib/models/porcelain.rb', line 15252

def healthy
  @healthy
end

#hostnameObject

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



15254
15255
15256
# File 'lib/models/porcelain.rb', line 15254

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



15256
15257
15258
# File 'lib/models/porcelain.rb', line 15256

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.



15258
15259
15260
# File 'lib/models/porcelain.rb', line 15258

def keytab
  @keytab
end

#krb_configObject

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



15260
15261
15262
# File 'lib/models/porcelain.rb', line 15260

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



15262
15263
15264
# File 'lib/models/porcelain.rb', line 15262

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.



15264
15265
15266
# File 'lib/models/porcelain.rb', line 15264

def override_database
  @override_database
end

#portObject

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



15266
15267
15268
# File 'lib/models/porcelain.rb', line 15266

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.



15268
15269
15270
# File 'lib/models/porcelain.rb', line 15268

def port_override
  @port_override
end

#proxy_cluster_idObject

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



15270
15271
15272
# File 'lib/models/porcelain.rb', line 15270

def proxy_cluster_id
  @proxy_cluster_id
end

#realmObject

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



15272
15273
15274
# File 'lib/models/porcelain.rb', line 15272

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



15274
15275
15276
# File 'lib/models/porcelain.rb', line 15274

def schema
  @schema
end

#secret_store_idObject

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



15276
15277
15278
# File 'lib/models/porcelain.rb', line 15276

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



15278
15279
15280
# File 'lib/models/porcelain.rb', line 15278

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.



15280
15281
15282
# File 'lib/models/porcelain.rb', line 15280

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



15282
15283
15284
# File 'lib/models/porcelain.rb', line 15282

def tags
  @tags
end

#usernameObject

The username to authenticate with.



15284
15285
15286
# File 'lib/models/porcelain.rb', line 15284

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



15332
15333
15334
15335
15336
15337
15338
# File 'lib/models/porcelain.rb', line 15332

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