Class: SDM::AmazonESIAM

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

Overview

AmazonESIAM 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(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.



2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'lib/models/porcelain.rb', line 2348

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.



2318
2319
2320
# File 'lib/models/porcelain.rb', line 2318

def bind_interface
  @bind_interface
end

#egress_filterObject

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



2320
2321
2322
# File 'lib/models/porcelain.rb', line 2320

def egress_filter
  @egress_filter
end

#endpointObject

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



2322
2323
2324
# File 'lib/models/porcelain.rb', line 2322

def endpoint
  @endpoint
end

#healthyObject

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



2324
2325
2326
# File 'lib/models/porcelain.rb', line 2324

def healthy
  @healthy
end

#idObject

Unique identifier of the Resource.



2326
2327
2328
# File 'lib/models/porcelain.rb', line 2326

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



2328
2329
2330
# File 'lib/models/porcelain.rb', line 2328

def name
  @name
end

#port_overrideObject

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



2330
2331
2332
# File 'lib/models/porcelain.rb', line 2330

def port_override
  @port_override
end

#proxy_cluster_idObject

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



2332
2333
2334
# File 'lib/models/porcelain.rb', line 2332

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

The AWS region to connect to.



2334
2335
2336
# File 'lib/models/porcelain.rb', line 2334

def region
  @region
end

#role_arnObject

The role to assume after logging in.



2336
2337
2338
# File 'lib/models/porcelain.rb', line 2336

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.



2338
2339
2340
# File 'lib/models/porcelain.rb', line 2338

def role_external_id
  @role_external_id
end

#secret_store_idObject

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



2340
2341
2342
# File 'lib/models/porcelain.rb', line 2340

def secret_store_id
  @secret_store_id
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



2342
2343
2344
# File 'lib/models/porcelain.rb', line 2342

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



2344
2345
2346
# File 'lib/models/porcelain.rb', line 2344

def tags
  @tags
end

#tlsrequiredObject

Use TLS to connect to the OpenSearch server



2346
2347
2348
# File 'lib/models/porcelain.rb', line 2346

def tlsrequired
  @tlsrequired
end

Instance Method Details

#to_json(options = {}) ⇒ Object



2382
2383
2384
2385
2386
2387
2388
# File 'lib/models/porcelain.rb', line 2382

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