Class: SDM::SSHCustomerKey

Inherits:

Object

• Object
• SDM::SSHCustomerKey

Defined in:

lib/models/porcelain.rb

Instance Attribute Summary

• #allow_deprecated_key_exchanges ⇒ Object

  Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

• #bind_interface ⇒ Object

  The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1).

• #egress_filter ⇒ Object

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

• #healthy ⇒ Object

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

• #hostname ⇒ Object

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

• #id ⇒ Object

  Unique identifier of the Resource.

• #identity_alias_healthcheck_username ⇒ Object

  The username to use for healthchecks, when clients otherwise connect with their own identity alias username.

• #identity_set_id ⇒ Object

  The ID of the identity set to use for identity connections.

• #name ⇒ Object

  Unique human-readable name of the Resource.

• #port ⇒ Object

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

• #port_forwarding ⇒ Object

  Whether port forwarding is allowed through this server.

• #port_override ⇒ Object

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

• #private_key ⇒ Object

  The private key used to authenticate with the server.

• #proxy_cluster_id ⇒ Object

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

• #secret_store_id ⇒ Object

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

• #subdomain ⇒ Object

  Subdomain is the local DNS address.

• #tags ⇒ Object

  Tags is a map of key, value pairs.

• #username ⇒ Object

  The username to authenticate with.

Instance Method Summary

• #initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, identity_alias_healthcheck_username: nil, identity_set_id: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, private_key: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSHCustomerKey constructor

  A new instance of SSHCustomerKey.

• #to_json(options = {}) ⇒ Object

Constructor Details

#initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, identity_alias_healthcheck_username: nil, identity_set_id: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, private_key: nil, proxy_cluster_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSHCustomerKey

Returns a new instance of SSHCustomerKey.

# File 'lib/models/porcelain.rb', line 13263

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  identity_alias_healthcheck_username: nil,
  identity_set_id: nil,
  name: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  private_key: nil,
  proxy_cluster_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_key_exchanges = allow_deprecated_key_exchanges == nil ? false : allow_deprecated_key_exchanges
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @identity_alias_healthcheck_username = identity_alias_healthcheck_username == nil ? "" : identity_alias_healthcheck_username
  @identity_set_id = identity_set_id == nil ? "" : identity_set_id
  @name = name == nil ? "" : name
  @port = port == nil ? 0 : port
  @port_forwarding = port_forwarding == nil ? false : port_forwarding
  @port_override = port_override == nil ? 0 : port_override
  @private_key = private_key == nil ? "" : private_key
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_key_exchanges ⇒ Object

Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.

# File 'lib/models/porcelain.rb', line 13227

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interface ⇒ Object

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.

# File 'lib/models/porcelain.rb', line 13229

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13231

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13233

def healthy
  @healthy
end

#hostname ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13235

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.

# File 'lib/models/porcelain.rb', line 13237

def id
  @id
end

#identity_alias_healthcheck_username ⇒ Object

The username to use for healthchecks, when clients otherwise connect with their own identity alias username.

# File 'lib/models/porcelain.rb', line 13239

def identity_alias_healthcheck_username
  @identity_alias_healthcheck_username
end

#identity_set_id ⇒ Object

The ID of the identity set to use for identity connections.

# File 'lib/models/porcelain.rb', line 13241

def identity_set_id
  @identity_set_id
end

#name ⇒ Object

Unique human-readable name of the Resource.

# File 'lib/models/porcelain.rb', line 13243

def name
  @name
end

#port ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13245

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.

# File 'lib/models/porcelain.rb', line 13247

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13249

def port_override
  @port_override
end

#private_key ⇒ Object

The private key used to authenticate with the server.

# File 'lib/models/porcelain.rb', line 13251

def private_key
  @private_key
end

#proxy_cluster_id ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13253

def proxy_cluster_id
  @proxy_cluster_id
end

#secret_store_id ⇒ Object

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

# File 'lib/models/porcelain.rb', line 13255

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)

# File 'lib/models/porcelain.rb', line 13257

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.

# File 'lib/models/porcelain.rb', line 13259

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.

# File 'lib/models/porcelain.rb', line 13261

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object

# File 'lib/models/porcelain.rb', line 13303

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