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.



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/models/porcelain.rb', line 675

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



641
642
643
 
# File 'lib/models/porcelain.rb', line 641

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



643
644
645
 
# File 'lib/models/porcelain.rb', line 643

def egress_filter
  @egress_filter
end

#enable_env_variables ⇒ Object

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



645
646
647
 
# File 'lib/models/porcelain.rb', line 645

def enable_env_variables
  @enable_env_variables
end

#healthy ⇒ Object

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



647
648
649
 
# File 'lib/models/porcelain.rb', line 647

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



649
650
651
 
# File 'lib/models/porcelain.rb', line 649

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.



651
652
653
 
# File 'lib/models/porcelain.rb', line 651

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.



653
654
655
 
# File 'lib/models/porcelain.rb', line 653

def identity_set_id
  @identity_set_id
end

#name ⇒ Object

Unique human-readable name of the Resource.



655
656
657
 
# File 'lib/models/porcelain.rb', line 655

def name
  @name
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



657
658
659
 
# File 'lib/models/porcelain.rb', line 657

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



659
660
661
 
# File 'lib/models/porcelain.rb', line 659

def proxy_cluster_id
  @proxy_cluster_id
end

#region ⇒ Object

The AWS region to connect to.



661
662
663
 
# File 'lib/models/porcelain.rb', line 661

def region
  @region
end

#role_arn ⇒ Object

The role to assume after logging in.



663
664
665
 
# File 'lib/models/porcelain.rb', line 663

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.



665
666
667
 
# File 'lib/models/porcelain.rb', line 665

def role_external_id
  @role_external_id
end

#secret_store_id ⇒ Object

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



667
668
669
 
# File 'lib/models/porcelain.rb', line 667

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.



669
670
671
 
# File 'lib/models/porcelain.rb', line 669

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)



671
672
673
 
# File 'lib/models/porcelain.rb', line 671

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



673
674
675
 
# File 'lib/models/porcelain.rb', line 673

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



713
714
715
716
717
718
719
 
# File 'lib/models/porcelain.rb', line 713

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