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.



6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
# File 'lib/models/porcelain.rb', line 6768

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.



6734
6735
6736
# File 'lib/models/porcelain.rb', line 6734

def bind_interface
  @bind_interface
end

#egress_filterObject

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



6736
6737
6738
# File 'lib/models/porcelain.rb', line 6736

def egress_filter
  @egress_filter
end

#healthyObject

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



6738
6739
6740
# File 'lib/models/porcelain.rb', line 6738

def healthy
  @healthy
end

#hostnameObject

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



6740
6741
6742
# File 'lib/models/porcelain.rb', line 6740

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



6742
6743
6744
# File 'lib/models/porcelain.rb', line 6742

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



6744
6745
6746
# File 'lib/models/porcelain.rb', line 6744

def name
  @name
end

#portObject

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



6746
6747
6748
# File 'lib/models/porcelain.rb', line 6746

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.



6748
6749
6750
# File 'lib/models/porcelain.rb', line 6748

def port_override
  @port_override
end

#proxy_cluster_idObject

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



6750
6751
6752
# File 'lib/models/porcelain.rb', line 6750

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

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



6752
6753
6754
# File 'lib/models/porcelain.rb', line 6752

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.



6754
6755
6756
# File 'lib/models/porcelain.rb', line 6754

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.



6756
6757
6758
# File 'lib/models/porcelain.rb', line 6756

def role_external_id
  @role_external_id
end

#secret_store_idObject

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



6758
6759
6760
# File 'lib/models/porcelain.rb', line 6758

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.



6760
6761
6762
# File 'lib/models/porcelain.rb', line 6760

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



6762
6763
6764
# File 'lib/models/porcelain.rb', line 6762

def tags
  @tags
end

#tls_requiredObject

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



6764
6765
6766
# File 'lib/models/porcelain.rb', line 6764

def tls_required
  @tls_required
end

#usernameObject

The username to authenticate with.



6766
6767
6768
# File 'lib/models/porcelain.rb', line 6766

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



6806
6807
6808
6809
6810
6811
6812
# File 'lib/models/porcelain.rb', line 6806

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