Class: SDM::AmazonES

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, 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_access_key: nil, secret_store_id: nil, subdomain: nil, tags: nil) ⇒ AmazonES

Returns a new instance of AmazonES.



3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
# File 'lib/models/porcelain.rb', line 3078

def initialize(
  access_key: nil,
  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_access_key: nil,
  secret_store_id: 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
  @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_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_keyObject

The Access Key ID to use to authenticate.



3046
3047
3048
# File 'lib/models/porcelain.rb', line 3046

def access_key
  @access_key
end

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



3048
3049
3050
# File 'lib/models/porcelain.rb', line 3048

def bind_interface
  @bind_interface
end

#egress_filterObject

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



3050
3051
3052
# File 'lib/models/porcelain.rb', line 3050

def egress_filter
  @egress_filter
end

#endpointObject

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



3052
3053
3054
# File 'lib/models/porcelain.rb', line 3052

def endpoint
  @endpoint
end

#healthyObject

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



3054
3055
3056
# File 'lib/models/porcelain.rb', line 3054

def healthy
  @healthy
end

#idObject

Unique identifier of the Resource.



3056
3057
3058
# File 'lib/models/porcelain.rb', line 3056

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



3058
3059
3060
# File 'lib/models/porcelain.rb', line 3058

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.



3060
3061
3062
# File 'lib/models/porcelain.rb', line 3060

def port_override
  @port_override
end

#proxy_cluster_idObject

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



3062
3063
3064
# File 'lib/models/porcelain.rb', line 3062

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

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



3064
3065
3066
# File 'lib/models/porcelain.rb', line 3064

def region
  @region
end

#role_arnObject

The role to assume after logging in.



3066
3067
3068
# File 'lib/models/porcelain.rb', line 3066

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.



3068
3069
3070
# File 'lib/models/porcelain.rb', line 3068

def role_external_id
  @role_external_id
end

#secret_access_keyObject

The Secret Access Key to use to authenticate.



3070
3071
3072
# File 'lib/models/porcelain.rb', line 3070

def secret_access_key
  @secret_access_key
end

#secret_store_idObject

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



3072
3073
3074
# File 'lib/models/porcelain.rb', line 3072

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.



3074
3075
3076
# File 'lib/models/porcelain.rb', line 3074

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



3076
3077
3078
# File 'lib/models/porcelain.rb', line 3076

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



3114
3115
3116
3117
3118
3119
3120
# File 'lib/models/porcelain.rb', line 3114

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