Class: SDM::AWSConsole

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

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.



495
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
 
# File 'lib/models/porcelain.rb', line 495

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.



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

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



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

def egress_filter
  @egress_filter
end

#enable_env_variables ⇒ Object

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



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

def enable_env_variables
  @enable_env_variables
end

#healthy ⇒ Object

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



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

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



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

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



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

def name
  @name
end

#port_override ⇒ Object

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



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

def port_override
  @port_override
end

#region ⇒ Object

The AWS region to connect to.



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

def region
  @region
end

#remote_identity_group_id ⇒ Object

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



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

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.



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

def remote_identity_healthcheck_username
  @remote_identity_healthcheck_username
end

#role_arn ⇒ Object

The role to assume after logging in.



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

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.



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

def role_external_id
  @role_external_id
end

#secret_store_id ⇒ Object

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



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

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.



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

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)



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

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



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

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