Class: SDM::AmazonEKS

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_key: nil, allow_resource_role_bypass: nil, bind_interface: nil, certificate_authority: nil, cluster_name: nil, discovery_enabled: nil, discovery_username: nil, egress_filter: nil, endpoint: nil, healthcheck_namespace: 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_access_key: nil, secret_store_id: nil, subdomain: nil, tags: nil) ⇒ AmazonEKS

Returns a new instance of AmazonEKS.



2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
 
# File 'lib/models/porcelain.rb', line 2723

def initialize(
  access_key: nil,
  allow_resource_role_bypass: nil,
  bind_interface: nil,
  certificate_authority: nil,
  cluster_name: nil,
  discovery_enabled: nil,
  discovery_username: nil,
  egress_filter: nil,
  endpoint: nil,
  healthcheck_namespace: 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_access_key: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil
)
  @access_key = access_key == nil ? "" : access_key
  @allow_resource_role_bypass = allow_resource_role_bypass == nil ? false : allow_resource_role_bypass
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @certificate_authority = certificate_authority == nil ? "" : certificate_authority
  @cluster_name = cluster_name == nil ? "" : cluster_name
  @discovery_enabled = discovery_enabled == nil ? false : discovery_enabled
  @discovery_username = discovery_username == nil ? "" : discovery_username
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @endpoint = endpoint == nil ? "" : endpoint
  @healthcheck_namespace = healthcheck_namespace == nil ? "" : healthcheck_namespace
  @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_access_key = secret_access_key == nil ? "" : secret_access_key
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @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 use to authenticate.



2673
2674
2675
 
# File 'lib/models/porcelain.rb', line 2673

def access_key
  @access_key
end

#allow_resource_role_bypass ⇒ Object

If true, allows users to fallback to the existing authentication mode (Leased Credential or Identity Set) when a resource role is not provided.



2676
2677
2678
 
# File 'lib/models/porcelain.rb', line 2676

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



2678
2679
2680
 
# File 'lib/models/porcelain.rb', line 2678

def bind_interface
  @bind_interface
end

#certificate_authority ⇒ Object

The CA to authenticate TLS connections with.



2680
2681
2682
 
# File 'lib/models/porcelain.rb', line 2680

def certificate_authority
  @certificate_authority
end

#cluster_name ⇒ Object

The name of the cluster to connect to.



2682
2683
2684
 
# File 'lib/models/porcelain.rb', line 2682

def cluster_name
  @cluster_name
end

#discovery_enabled ⇒ Object

If true, configures discovery of a cluster to be run from a node.



2684
2685
2686
 
# File 'lib/models/porcelain.rb', line 2684

def discovery_enabled
  @discovery_enabled
end

#discovery_username ⇒ Object

If a cluster is configured for user impersonation, this is the user to impersonate when running discovery.



2687
2688
2689
 
# File 'lib/models/porcelain.rb', line 2687

def discovery_username
  @discovery_username
end

#egress_filter ⇒ Object

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



2689
2690
2691
 
# File 'lib/models/porcelain.rb', line 2689

def egress_filter
  @egress_filter
end

#endpoint ⇒ Object

The endpoint to dial.



2691
2692
2693
 
# File 'lib/models/porcelain.rb', line 2691

def endpoint
  @endpoint
end

#healthcheck_namespace ⇒ Object

The path used to check the health of your connection. Defaults to default.



2693
2694
2695
 
# File 'lib/models/porcelain.rb', line 2693

def healthcheck_namespace
  @healthcheck_namespace
end

#healthy ⇒ Object

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



2695
2696
2697
 
# File 'lib/models/porcelain.rb', line 2695

def healthy
  @healthy
end

#id ⇒ Object

Unique identifier of the Resource.



2697
2698
2699
 
# File 'lib/models/porcelain.rb', line 2697

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.



2699
2700
2701
 
# File 'lib/models/porcelain.rb', line 2699

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.



2701
2702
2703
 
# File 'lib/models/porcelain.rb', line 2701

def identity_set_id
  @identity_set_id
end

#name ⇒ Object

Unique human-readable name of the Resource.



2703
2704
2705
 
# File 'lib/models/porcelain.rb', line 2703

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.



2705
2706
2707
 
# File 'lib/models/porcelain.rb', line 2705

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



2707
2708
2709
 
# File 'lib/models/porcelain.rb', line 2707

def proxy_cluster_id
  @proxy_cluster_id
end

#region ⇒ Object

The AWS region to connect to e.g. us-east-1.



2709
2710
2711
 
# File 'lib/models/porcelain.rb', line 2709

def region
  @region
end

#role_arn ⇒ Object

The role to assume after logging in.



2711
2712
2713
 
# File 'lib/models/porcelain.rb', line 2711

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.



2713
2714
2715
 
# File 'lib/models/porcelain.rb', line 2713

def role_external_id
  @role_external_id
end

#secret_access_key ⇒ Object

The Secret Access Key to use to authenticate.



2715
2716
2717
 
# File 'lib/models/porcelain.rb', line 2715

def secret_access_key
  @secret_access_key
end

#secret_store_id ⇒ Object

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



2717
2718
2719
 
# File 'lib/models/porcelain.rb', line 2717

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



2719
2720
2721
 
# File 'lib/models/porcelain.rb', line 2719

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



2721
2722
2723
 
# File 'lib/models/porcelain.rb', line 2721

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/models/porcelain.rb', line 2775

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