Class: SDM::ElasticacheRedisIAM

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

Overview

ElasticacheRedisIAM 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, healthy: nil, hostname: nil, id: nil, name: nil, port: nil, port_override: nil, proxy_cluster_id: nil, region: nil, role_assumption_arn: nil, role_external_id: nil, secret_store_id: nil, subdomain: nil, tags: nil, tls_required: nil, username: nil) ⇒ ElasticacheRedisIAM

Returns a new instance of ElasticacheRedisIAM.



7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
# File 'lib/models/porcelain.rb', line 7209

def initialize(
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  name: nil,
  port: nil,
  port_override: nil,
  proxy_cluster_id: nil,
  region: nil,
  role_assumption_arn: nil,
  role_external_id: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  tls_required: nil,
  username: nil
)
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @region = region == nil ? "" : region
  @role_assumption_arn = role_assumption_arn == nil ? "" : role_assumption_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
  @tls_required = tls_required == nil ? false : tls_required
  @username = username == nil ? "" : username
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.



7175
7176
7177
# File 'lib/models/porcelain.rb', line 7175

def bind_interface
  @bind_interface
end

#egress_filterObject

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



7177
7178
7179
# File 'lib/models/porcelain.rb', line 7177

def egress_filter
  @egress_filter
end

#healthyObject

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



7179
7180
7181
# File 'lib/models/porcelain.rb', line 7179

def healthy
  @healthy
end

#hostnameObject

The host to dial to initiate a connection from the egress node to this resource.



7181
7182
7183
# File 'lib/models/porcelain.rb', line 7181

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



7183
7184
7185
# File 'lib/models/porcelain.rb', line 7183

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



7185
7186
7187
# File 'lib/models/porcelain.rb', line 7185

def name
  @name
end

#portObject

The port to dial to initiate a connection from the egress node to this resource.



7187
7188
7189
# File 'lib/models/porcelain.rb', line 7187

def port
  @port
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.



7189
7190
7191
# File 'lib/models/porcelain.rb', line 7189

def port_override
  @port_override
end

#proxy_cluster_idObject

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



7191
7192
7193
# File 'lib/models/porcelain.rb', line 7191

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

AWS region is needed in addition to hostname to generate the IAM signature



7193
7194
7195
# File 'lib/models/porcelain.rb', line 7193

def region
  @region
end

#role_assumption_arnObject

If provided, the gateway/relay will try to assume this role instead of the underlying compute's role.



7195
7196
7197
# File 'lib/models/porcelain.rb', line 7195

def role_assumption_arn
  @role_assumption_arn
end

#role_external_idObject

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



7197
7198
7199
# File 'lib/models/porcelain.rb', line 7197

def role_external_id
  @role_external_id
end

#secret_store_idObject

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



7199
7200
7201
# File 'lib/models/porcelain.rb', line 7199

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.



7201
7202
7203
# File 'lib/models/porcelain.rb', line 7201

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



7203
7204
7205
# File 'lib/models/porcelain.rb', line 7203

def tags
  @tags
end

#tls_requiredObject

If set, TLS must be used to connect to this resource.



7205
7206
7207
# File 'lib/models/porcelain.rb', line 7205

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



7207
7208
7209
# File 'lib/models/porcelain.rb', line 7207

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



7247
7248
7249
7250
7251
7252
7253
# File 'lib/models/porcelain.rb', line 7247

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