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.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/models/porcelain.rb', line 542

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.



510
511
512
 
# File 'lib/models/porcelain.rb', line 510

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



512
513
514
 
# File 'lib/models/porcelain.rb', line 512

def egress_filter
  @egress_filter
end

#enable_env_variables ⇒ Object

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



514
515
516
 
# File 'lib/models/porcelain.rb', line 514

def enable_env_variables
  @enable_env_variables
end

#healthy ⇒ Object

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



516
517
518
 
# File 'lib/models/porcelain.rb', line 516

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



518
519
520
 
# File 'lib/models/porcelain.rb', line 518

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



520
521
522
 
# File 'lib/models/porcelain.rb', line 520

def name
  @name
end

#port_override ⇒ Object

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



522
523
524
 
# File 'lib/models/porcelain.rb', line 522

def port_override
  @port_override
end

#region ⇒ Object

The AWS region to connect to.



524
525
526
 
# File 'lib/models/porcelain.rb', line 524

def region
  @region
end

#remote_identity_group_id ⇒ Object

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



526
527
528
 
# File 'lib/models/porcelain.rb', line 526

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.



528
529
530
 
# File 'lib/models/porcelain.rb', line 528

def remote_identity_healthcheck_username
  @remote_identity_healthcheck_username
end

#role_arn ⇒ Object

The role to assume after logging in.



530
531
532
 
# File 'lib/models/porcelain.rb', line 530

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.



532
533
534
 
# File 'lib/models/porcelain.rb', line 532

def role_external_id
  @role_external_id
end

#secret_store_id ⇒ Object

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



534
535
536
 
# File 'lib/models/porcelain.rb', line 534

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.



536
537
538
 
# File 'lib/models/porcelain.rb', line 536

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)



538
539
540
 
# File 'lib/models/porcelain.rb', line 538

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



540
541
542
 
# File 'lib/models/porcelain.rb', line 540

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



578
579
580
581
582
583
584
 
# File 'lib/models/porcelain.rb', line 578

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