Class: SDM::DocumentDBHostIAM

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

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

Returns a new instance of DocumentDBHostIAM.



5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
# File 'lib/models/porcelain.rb', line 5798

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,
  secret_store_id: nil,
  subdomain: nil,
  tags: 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
  @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

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



5772
5773
5774
# File 'lib/models/porcelain.rb', line 5772

def bind_interface
  @bind_interface
end

#egress_filterObject

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



5774
5775
5776
# File 'lib/models/porcelain.rb', line 5774

def egress_filter
  @egress_filter
end

#healthyObject

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



5776
5777
5778
# File 'lib/models/porcelain.rb', line 5776

def healthy
  @healthy
end

#hostnameObject

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



5778
5779
5780
# File 'lib/models/porcelain.rb', line 5778

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



5780
5781
5782
# File 'lib/models/porcelain.rb', line 5780

def id
  @id
end

#nameObject

Unique human-readable name of the Resource.



5782
5783
5784
# File 'lib/models/porcelain.rb', line 5782

def name
  @name
end

#portObject

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



5784
5785
5786
# File 'lib/models/porcelain.rb', line 5784

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.



5786
5787
5788
# File 'lib/models/porcelain.rb', line 5786

def port_override
  @port_override
end

#proxy_cluster_idObject

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



5788
5789
5790
# File 'lib/models/porcelain.rb', line 5788

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

The AWS region to connect to.



5790
5791
5792
# File 'lib/models/porcelain.rb', line 5790

def region
  @region
end

#secret_store_idObject

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



5792
5793
5794
# File 'lib/models/porcelain.rb', line 5792

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.



5794
5795
5796
# File 'lib/models/porcelain.rb', line 5794

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



5796
5797
5798
# File 'lib/models/porcelain.rb', line 5796

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



5828
5829
5830
5831
5832
5833
5834
# File 'lib/models/porcelain.rb', line 5828

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