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.



6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
# File 'lib/models/porcelain.rb', line 6724

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.



6690
6691
6692
# File 'lib/models/porcelain.rb', line 6690

def bind_interface
  @bind_interface
end

#egress_filterObject

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



6692
6693
6694
# File 'lib/models/porcelain.rb', line 6692

def egress_filter
  @egress_filter
end

#healthyObject

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



6694
6695
6696
# File 'lib/models/porcelain.rb', line 6694

def healthy
  @healthy
end

#hostnameObject

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



6696
6697
6698
# File 'lib/models/porcelain.rb', line 6696

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6698
6699
6700
# File 'lib/models/porcelain.rb', line 6698

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6700
6701
6702
# File 'lib/models/porcelain.rb', line 6700

def name
  @name
end

#portObject

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



6702
6703
6704
# File 'lib/models/porcelain.rb', line 6702

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.



6704
6705
6706
# File 'lib/models/porcelain.rb', line 6704

def port_override
  @port_override
end

#proxy_cluster_idObject

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



6706
6707
6708
# File 'lib/models/porcelain.rb', line 6706

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

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



6708
6709
6710
# File 'lib/models/porcelain.rb', line 6708

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.



6710
6711
6712
# File 'lib/models/porcelain.rb', line 6710

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.



6712
6713
6714
# File 'lib/models/porcelain.rb', line 6712

def role_external_id
  @role_external_id
end

#secret_store_idObject

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



6714
6715
6716
# File 'lib/models/porcelain.rb', line 6714

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.



6716
6717
6718
# File 'lib/models/porcelain.rb', line 6716

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6718
6719
6720
# File 'lib/models/porcelain.rb', line 6718

def tags
  @tags
end

#tls_requiredObject

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



6720
6721
6722
# File 'lib/models/porcelain.rb', line 6720

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



6722
6723
6724
# File 'lib/models/porcelain.rb', line 6722

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6762
6763
6764
6765
6766
6767
6768
# File 'lib/models/porcelain.rb', line 6762

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