Class: SDM::AWSConsoleStaticKeyPair

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, healthy: nil, id: nil, identity_alias_healthcheck_username: nil, identity_set_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, session_expiry: nil, subdomain: nil, tags: nil, use_https: nil) ⇒ AWSConsoleStaticKeyPair

Returns a new instance of AWSConsoleStaticKeyPair.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/models/porcelain.rb', line 1068

def initialize(
  access_key: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  id: nil,
  identity_alias_healthcheck_username: nil,
  identity_set_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,
  session_expiry: nil,
  subdomain: nil,
  tags: nil,
  use_https: nil
)
  @access_key = access_key == nil ? "" : access_key
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @id = id == nil ? "" : id
  @identity_alias_healthcheck_username = identity_alias_healthcheck_username == nil ? "" : identity_alias_healthcheck_username
  @identity_set_id = identity_set_id == nil ? "" : identity_set_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
  @session_expiry = session_expiry == nil ? 0 : session_expiry
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @use_https = use_https == nil ? false : use_https
end

Instance Attribute Details

#access_keyObject

The Access Key ID to authenticate with.



1030
1031
1032
# File 'lib/models/porcelain.rb', line 1030

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.



1032
1033
1034
# File 'lib/models/porcelain.rb', line 1032

def bind_interface
  @bind_interface
end

#egress_filterObject

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



1034
1035
1036
# File 'lib/models/porcelain.rb', line 1034

def egress_filter
  @egress_filter
end

#healthyObject

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



1036
1037
1038
# File 'lib/models/porcelain.rb', line 1036

def healthy
  @healthy
end

#idObject

Unique identifier of the Resource.



1038
1039
1040
# File 'lib/models/porcelain.rb', line 1038

def id
  @id
end

#identity_alias_healthcheck_usernameObject

The username to use for healthchecks, when clients otherwise connect with their own identity alias username.



1040
1041
1042
# File 'lib/models/porcelain.rb', line 1040

def identity_alias_healthcheck_username
  @identity_alias_healthcheck_username
end

#identity_set_idObject

The ID of the identity set to use for identity connections.



1042
1043
1044
# File 'lib/models/porcelain.rb', line 1042

def identity_set_id
  @identity_set_id
end

#nameObject

Unique human-readable name of the Resource.



1044
1045
1046
# File 'lib/models/porcelain.rb', line 1044

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.



1046
1047
1048
# File 'lib/models/porcelain.rb', line 1046

def port_override
  @port_override
end

#proxy_cluster_idObject

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



1048
1049
1050
# File 'lib/models/porcelain.rb', line 1048

def proxy_cluster_id
  @proxy_cluster_id
end

#regionObject

The AWS region to connect to.



1050
1051
1052
# File 'lib/models/porcelain.rb', line 1050

def region
  @region
end

#role_arnObject

The role to assume after logging in.



1052
1053
1054
# File 'lib/models/porcelain.rb', line 1052

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.



1054
1055
1056
# File 'lib/models/porcelain.rb', line 1054

def role_external_id
  @role_external_id
end

#secret_access_keyObject

The Secret Access Key to authenticate with.



1056
1057
1058
# File 'lib/models/porcelain.rb', line 1056

def secret_access_key
  @secret_access_key
end

#secret_store_idObject

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



1058
1059
1060
# File 'lib/models/porcelain.rb', line 1058

def secret_store_id
  @secret_store_id
end

#session_expiryObject

The length of time in seconds AWS console sessions will live before needing to reauthenticate.



1060
1061
1062
# File 'lib/models/porcelain.rb', line 1060

def session_expiry
  @session_expiry
end

#subdomainObject

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



1062
1063
1064
# File 'lib/models/porcelain.rb', line 1062

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



1064
1065
1066
# File 'lib/models/porcelain.rb', line 1064

def tags
  @tags
end

#use_httpsObject

This option enforces HTTPS on the client, not resource connection



1066
1067
1068
# File 'lib/models/porcelain.rb', line 1066

def use_https
  @use_https
end

Instance Method Details

#to_json(options = {}) ⇒ Object



1110
1111
1112
1113
1114
1115
1116
# File 'lib/models/porcelain.rb', line 1110

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