Class: SDM::AWSConsoleStaticKeyPair

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

Overview

AWSConsoleStaticKeyPair 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(access_key: nil, bind_interface: nil, egress_filter: 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_access_key: nil, secret_store_id: nil, session_expiry: nil, subdomain: nil, tags: nil) ⇒ AWSConsoleStaticKeyPair

Returns a new instance of AWSConsoleStaticKeyPair.



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/models/porcelain.rb', line 578

def initialize(
  access_key: nil,
  bind_interface: nil,
  egress_filter: 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_access_key: nil,
  secret_store_id: nil,
  session_expiry: nil,
  subdomain: nil,
  tags: nil
)
  @access_key = access_key == nil ? "" : access_key
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @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_access_key = secret_access_key == nil ? "" : secret_access_key
  @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

#access_key ⇒ Object

The Access Key ID to authenticate with.



544
545
546
 
# File 'lib/models/porcelain.rb', line 544

def access_key
  @access_key
end

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



546
547
548
 
# File 'lib/models/porcelain.rb', line 546

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



548
549
550
 
# File 'lib/models/porcelain.rb', line 548

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



550
551
552
 
# File 'lib/models/porcelain.rb', line 550

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



552
553
554
 
# File 'lib/models/porcelain.rb', line 552

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Resource.



554
555
556
 
# File 'lib/models/porcelain.rb', line 554

def name
  @name
end

#port_override ⇒ Object

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



556
557
558
 
# File 'lib/models/porcelain.rb', line 556

def port_override
  @port_override
end

#region ⇒ Object

The AWS region to connect to.



558
559
560
 
# File 'lib/models/porcelain.rb', line 558

def region
  @region
end

#remote_identity_group_id ⇒ Object

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



560
561
562
 
# File 'lib/models/porcelain.rb', line 560

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.



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

def remote_identity_healthcheck_username
  @remote_identity_healthcheck_username
end

#role_arn ⇒ Object

The role to assume after logging in.



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

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.



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

def role_external_id
  @role_external_id
end

#secret_access_key ⇒ Object

The Secret Access Key to authenticate with.



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

def secret_access_key
  @secret_access_key
end

#secret_store_id ⇒ Object

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



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

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.



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

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)



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

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



616
617
618
619
620
621
622
 
# File 'lib/models/porcelain.rb', line 616

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