Class: OCI::Dbmulticloud::Models::OracleDbAwsIdentityConnector

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb

Overview

Oracle DB AWS Connector resource object.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OracleDbAwsIdentityConnector

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :issuer_url (String) —

    The value to assign to the #issuer_url property

  • :oidc_scope (String) —

    The value to assign to the #oidc_scope property

  • :service_role_details (Array<OCI::Dbmulticloud::Models::ServiceRoleDetails>) —

    The value to assign to the #service_role_details property

  • :aws_location (String) —

    The value to assign to the #aws_location property

  • :aws_sts_private_endpoint (String) —

    The value to assign to the #aws_sts_private_endpoint property

  • :aws_account_id (String) —

    The value to assign to the #aws_account_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_state_details (String) —

    The value to assign to the #lifecycle_state_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 178

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

  raise 'You cannot provide both :resourceId and :resource_id' if attributes.key?(:'resourceId') && attributes.key?(:'resource_id')

  self.resource_id = attributes[:'resource_id'] if attributes[:'resource_id']

  self.issuer_url = attributes[:'issuerUrl'] if attributes[:'issuerUrl']

  raise 'You cannot provide both :issuerUrl and :issuer_url' if attributes.key?(:'issuerUrl') && attributes.key?(:'issuer_url')

  self.issuer_url = attributes[:'issuer_url'] if attributes[:'issuer_url']

  self.oidc_scope = attributes[:'oidcScope'] if attributes[:'oidcScope']

  raise 'You cannot provide both :oidcScope and :oidc_scope' if attributes.key?(:'oidcScope') && attributes.key?(:'oidc_scope')

  self.oidc_scope = attributes[:'oidc_scope'] if attributes[:'oidc_scope']

  self.service_role_details = attributes[:'serviceRoleDetails'] if attributes[:'serviceRoleDetails']

  raise 'You cannot provide both :serviceRoleDetails and :service_role_details' if attributes.key?(:'serviceRoleDetails') && attributes.key?(:'service_role_details')

  self.service_role_details = attributes[:'service_role_details'] if attributes[:'service_role_details']

  self.aws_location = attributes[:'awsLocation'] if attributes[:'awsLocation']

  raise 'You cannot provide both :awsLocation and :aws_location' if attributes.key?(:'awsLocation') && attributes.key?(:'aws_location')

  self.aws_location = attributes[:'aws_location'] if attributes[:'aws_location']

  self.aws_sts_private_endpoint = attributes[:'awsStsPrivateEndpoint'] if attributes[:'awsStsPrivateEndpoint']

  raise 'You cannot provide both :awsStsPrivateEndpoint and :aws_sts_private_endpoint' if attributes.key?(:'awsStsPrivateEndpoint') && attributes.key?(:'aws_sts_private_endpoint')

  self.aws_sts_private_endpoint = attributes[:'aws_sts_private_endpoint'] if attributes[:'aws_sts_private_endpoint']

  self. = attributes[:'awsAccountId'] if attributes[:'awsAccountId']

  raise 'You cannot provide both :awsAccountId and :aws_account_id' if attributes.key?(:'awsAccountId') && attributes.key?(:'aws_account_id')

  self. = attributes[:'aws_account_id'] if attributes[:'aws_account_id']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails']

  raise 'You cannot provide both :lifecycleStateDetails and :lifecycle_state_details' if attributes.key?(:'lifecycleStateDetails') && attributes.key?(:'lifecycle_state_details')

  self.lifecycle_state_details = attributes[:'lifecycle_state_details'] if attributes[:'lifecycle_state_details']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#aws_account_id ⇒ String

AWS Account ID.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 62

def 
  @aws_account_id
end

#aws_location ⇒ String

[Required] AWS resource location.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 54

def aws_location
  @aws_location
end

#aws_sts_private_endpoint ⇒ String

Private endpoint of AWS Security Token Service.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 58

def aws_sts_private_endpoint
  @aws_sts_private_endpoint
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains Oracle DB AWS Identity Connector resource.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 33

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


96
97
98
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 96

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Oracle DB AWS Identity Connector resource name.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 29

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


88
89
90
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Oracle DB AWS Identity Connector resource.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 25

def id
  @id
end

#issuer_url ⇒ String

[Required] OIDC token issuer Url.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 41

def issuer_url
  @issuer_url
end

#lifecycle_state ⇒ String

The current lifecycle state of the AWS Identity Connector resource.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

Description of the current lifecycle state in more detail.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 70

def lifecycle_state_details
  @lifecycle_state_details
end

#oidc_scope ⇒ String

OCI IAM Domain scope for issuer URL.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 45

def oidc_scope
  @oidc_scope
end

#resource_id ⇒ String

[Required] The OCID of the AWS VM Cluster resource.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 37

def resource_id
  @resource_id
end

#service_role_details ⇒ Array<OCI::Dbmulticloud::Models::ServiceRoleDetails>

[Required] Service role details and respective Amazon resource nam of Role.

Returns:



50
51
52
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 50

def service_role_details
  @service_role_details
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


103
104
105
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 103

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Time when the Oracle DB AWS Identity Connector resource was created expressed in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'.

Returns:

  • (DateTime) 


75
76
77
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 75

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Time when the Oracle DB AWS Identity Connector resource was last modified expressed in RFC 3339 timestamp format, e.g. '2020-05-22T21:10:29.600Z'.

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 80

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'resource_id': :'resourceId',
    'issuer_url': :'issuerUrl',
    'oidc_scope': :'oidcScope',
    'service_role_details': :'serviceRoleDetails',
    'aws_location': :'awsLocation',
    'aws_sts_private_endpoint': :'awsStsPrivateEndpoint',
    'aws_account_id': :'awsAccountId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 131

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'resource_id': :'String',
    'issuer_url': :'String',
    'oidc_scope': :'String',
    'service_role_details': :'Array<OCI::Dbmulticloud::Models::ServiceRoleDetails>',
    'aws_location': :'String',
    'aws_sts_private_endpoint': :'String',
    'aws_account_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 303

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    resource_id == other.resource_id &&
    issuer_url == other.issuer_url &&
    oidc_scope == other.oidc_scope &&
    service_role_details == other.service_role_details &&
    aws_location == other.aws_location &&
    aws_sts_private_endpoint == other.aws_sts_private_endpoint &&
     == other. &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 349

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 329

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 338

def hash
  [id, display_name, compartment_id, resource_id, issuer_url, oidc_scope, service_role_details, aws_location, aws_sts_private_endpoint, , lifecycle_state, lifecycle_state_details, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 382

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



376
377
378
 
# File 'lib/oci/dbmulticloud/models/oracle_db_aws_identity_connector.rb', line 376

def to_s
  to_hash.to_s
end