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, identity_alias_healthcheck_username: nil, identity_set_id: nil, name: nil, port_override: nil, proxy_cluster_id: nil, region: 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.



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/models/porcelain.rb', line 597

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  enable_env_variables: nil,
  healthy: nil,
  id: nil,
  identity_alias_healthcheck_username: nil,
  identity_set_id: nil,
  name: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  region: 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
  @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_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @region = region == nil ? "" : region
  @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.



563
564
565
 
# File 'lib/models/porcelain.rb', line 563

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



565
566
567
 
# File 'lib/models/porcelain.rb', line 565

def egress_filter
  @egress_filter
end

#enable_env_variables ⇒ Object

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



567
568
569
 
# File 'lib/models/porcelain.rb', line 567

def enable_env_variables
  @enable_env_variables
end

#healthy ⇒ Object

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



569
570
571
 
# File 'lib/models/porcelain.rb', line 569

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



571
572
573
 
# File 'lib/models/porcelain.rb', line 571

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.



573
574
575
 
# File 'lib/models/porcelain.rb', line 573

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.



575
576
577
 
# File 'lib/models/porcelain.rb', line 575

def identity_set_id
  @identity_set_id
end

#name ⇒ Object

Unique human-readable name of the Resource.



577
578
579
 
# File 'lib/models/porcelain.rb', line 577

def name
  @name
end

#port_override ⇒ Object

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



579
580
581
 
# File 'lib/models/porcelain.rb', line 579

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



581
582
583
 
# File 'lib/models/porcelain.rb', line 581

def proxy_cluster_id
  @proxy_cluster_id
end

#region ⇒ Object

The AWS region to connect to.



583
584
585
 
# File 'lib/models/porcelain.rb', line 583

def region
  @region
end

#role_arn ⇒ Object

The role to assume after logging in.



585
586
587
 
# File 'lib/models/porcelain.rb', line 585

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.



587
588
589
 
# File 'lib/models/porcelain.rb', line 587

def role_external_id
  @role_external_id
end

#secret_store_id ⇒ Object

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



589
590
591
 
# File 'lib/models/porcelain.rb', line 589

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.



591
592
593
 
# File 'lib/models/porcelain.rb', line 591

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)



593
594
595
 
# File 'lib/models/porcelain.rb', line 593

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



595
596
597
 
# File 'lib/models/porcelain.rb', line 595

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



635
636
637
638
639
640
641
 
# File 'lib/models/porcelain.rb', line 635

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