Class: SDM::AmazonESIAM

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, endpoint: nil, healthy: nil, id: nil, name: nil, port_override: nil, proxy_cluster_id: nil, region: nil, role_arn: nil, role_external_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, tlsrequired: nil) ⇒ AmazonESIAM

Returns a new instance of AmazonESIAM.



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
# File 'lib/models/porcelain.rb', line 2858

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  endpoint: nil,
  healthy: nil,
  id: nil,
  name: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  region: nil,
  role_arn: nil,
  role_external_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  tlsrequired: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @endpoint = endpoint == nil ? "" : endpoint
  @healthy = healthy == nil ? false : healthy
  @id = id == nil ? "" : 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
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @tlsrequired = tlsrequired == nil ? false : tlsrequired
end

Instance Attribute Details

#bind_interfaceObject

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.



2828
2829
2830
# File 'lib/models/porcelain.rb', line 2828

def bind_interface
  @bind_interface
end

#egress_filterObject

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



2830
2831
2832
# File 'lib/models/porcelain.rb', line 2830

def egress_filter
  @egress_filter
end

#endpointObject

The endpoint to dial e.g. search-?.region.es.amazonaws.com"



2832
2833
2834
# File 'lib/models/porcelain.rb', line 2832

def endpoint
  @endpoint
end

#healthyObject

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



2834
2835
2836
# File 'lib/models/porcelain.rb', line 2834

def healthy
  @healthy
end

#idObject

Unique identifier of the Resource.



2836
2837
2838
# File 'lib/models/porcelain.rb', line 2836

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



2838
2839
2840
# File 'lib/models/porcelain.rb', line 2838

def name
  @name
end

#port_overrideObject

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.



2840
2841
2842
# File 'lib/models/porcelain.rb', line 2840

def port_override
  @port_override
end

#proxy_cluster_idObject

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



2842
2843
2844
# File 'lib/models/porcelain.rb', line 2842

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

The AWS region to connect to.



2844
2845
2846
# File 'lib/models/porcelain.rb', line 2844

def region
  @region
end

#role_arnObject

The role to assume after logging in.



2846
2847
2848
# File 'lib/models/porcelain.rb', line 2846

def role_arn
  @role_arn
end

#role_external_idObject

The external ID to associate with assume role requests. Does nothing if a role ARN is not provided.



2848
2849
2850
# File 'lib/models/porcelain.rb', line 2848

def role_external_id
  @role_external_id
end

#secret_store_idObject

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



2850
2851
2852
# File 'lib/models/porcelain.rb', line 2850

def secret_store_id
  @secret_store_id
end

#subdomainObject

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.



2852
2853
2854
# File 'lib/models/porcelain.rb', line 2852

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



2854
2855
2856
# File 'lib/models/porcelain.rb', line 2854

def tags
  @tags
end

#tlsrequiredObject

Use TLS to connect to the OpenSearch server



2856
2857
2858
# File 'lib/models/porcelain.rb', line 2856

def tlsrequired
  @tlsrequired
end

Instance Method Details

#to_json(options = {}) ⇒ Object



2892
2893
2894
2895
2896
2897
2898
# File 'lib/models/porcelain.rb', line 2892

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