Class: SDM::AWSConsole

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

AWSConsole is currently unstable, and its API may change, or it may be removed, without a major version bump.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_interface: nil, egress_filter: nil, enable_env_variables: nil, healthy: nil, id: nil, name: nil, port_override: nil, region: nil, remote_identity_group_id: nil, remote_identity_healthcheck_username: nil, role_arn: nil, role_external_id: nil, secret_store_id: nil, session_expiry: nil, subdomain: nil, tags: nil) ⇒ AWSConsole

Returns a new instance of AWSConsole.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/models/porcelain.rb', line 496

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  enable_env_variables: nil,
  healthy: nil,
  id: nil,
  name: nil,
  port_override: nil,
  region: nil,
  remote_identity_group_id: nil,
  remote_identity_healthcheck_username: nil,
  role_arn: nil,
  role_external_id: nil,
  secret_store_id: nil,
  session_expiry: nil,
  subdomain: nil,
  tags: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @enable_env_variables = enable_env_variables == nil ? false : enable_env_variables
  @healthy = healthy == nil ? false : healthy
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @port_override = port_override == nil ? 0 : port_override
  @region = region == nil ? "" : region
  @remote_identity_group_id = remote_identity_group_id == nil ? "" : remote_identity_group_id
  @remote_identity_healthcheck_username = remote_identity_healthcheck_username == nil ? "" : remote_identity_healthcheck_username
  @role_arn = role_arn == nil ? "" : role_arn
  @role_external_id = role_external_id == nil ? "" : role_external_id
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @session_expiry = session_expiry == nil ? 0 : session_expiry
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#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.



464
465
466
 
# File 'lib/models/porcelain.rb', line 464

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



466
467
468
 
# File 'lib/models/porcelain.rb', line 466

def egress_filter
  @egress_filter
end

#enable_env_variables ⇒ Object

If true, prefer environment variables to authenticate connection even if EC2 roles are configured.



468
469
470
 
# File 'lib/models/porcelain.rb', line 468

def enable_env_variables
  @enable_env_variables
end

#healthy ⇒ Object

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



470
471
472
 
# File 'lib/models/porcelain.rb', line 470

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



472
473
474
 
# File 'lib/models/porcelain.rb', line 472

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



474
475
476
 
# File 'lib/models/porcelain.rb', line 474

def name
  @name
end

#port_override ⇒ Object

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



476
477
478
 
# File 'lib/models/porcelain.rb', line 476

def port_override
  @port_override
end

#region ⇒ Object

The AWS region to connect to.



478
479
480
 
# File 'lib/models/porcelain.rb', line 478

def region
  @region
end

#remote_identity_group_id ⇒ Object

The ID of the remote identity group to use for remote identity connections.



480
481
482
 
# File 'lib/models/porcelain.rb', line 480

def remote_identity_group_id
  @remote_identity_group_id
end

#remote_identity_healthcheck_username ⇒ Object

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



482
483
484
 
# File 'lib/models/porcelain.rb', line 482

def remote_identity_healthcheck_username
  @remote_identity_healthcheck_username
end

#role_arn ⇒ Object

The role to assume after logging in.



484
485
486
 
# File 'lib/models/porcelain.rb', line 484

def role_arn
  @role_arn
end

#role_external_id ⇒ Object

The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.



486
487
488
 
# File 'lib/models/porcelain.rb', line 486

def role_external_id
  @role_external_id
end

#secret_store_id ⇒ Object

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



488
489
490
 
# File 'lib/models/porcelain.rb', line 488

def secret_store_id
  @secret_store_id
end

#session_expiry ⇒ Object

The length of time in seconds AWS console sessions will live before needing to reauthenticate.



490
491
492
 
# File 'lib/models/porcelain.rb', line 490

def session_expiry
  @session_expiry
end

#subdomain ⇒ Object

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



492
493
494
 
# File 'lib/models/porcelain.rb', line 492

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



494
495
496
 
# File 'lib/models/porcelain.rb', line 494

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



532
533
534
535
536
537
538
 
# File 'lib/models/porcelain.rb', line 532

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