Class: OCI::GoldenGate::Models::UpdateAmazonS3ConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb

Overview

The information to update a the Amazon S3 Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #key_id, #nsg_ids, #routing_method, #security_attributes, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateAmazonS3ConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

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

    The value to assign to the #freeform_tags proprety

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

    The value to assign to the #defined_tags proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

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

    The value to assign to the #security_attributes proprety

  • :access_key_id (String) —

    The value to assign to the #access_key_id property

  • :secret_access_key (String) —

    The value to assign to the #secret_access_key property

  • :secret_access_key_secret_id (String) —

    The value to assign to the #secret_access_key_secret_id property

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :region (String) —

    The value to assign to the #region property



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 118

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

  attributes['connectionType'] = 'AMAZON_S3'

  super(attributes)

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

  self.access_key_id = attributes[:'accessKeyId'] if attributes[:'accessKeyId']

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

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

  self.secret_access_key = attributes[:'secretAccessKey'] if attributes[:'secretAccessKey']

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

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

  self.secret_access_key_secret_id = attributes[:'secretAccessKeySecretId'] if attributes[:'secretAccessKeySecretId']

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

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

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

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

Instance Attribute Details

#access_key_id ⇒ String

Access key ID to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret"

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 17

def access_key_id
  @access_key_id
end

#endpoint ⇒ String

The Amazon Endpoint for S3. e.g.: 'my-bucket.s3.us-east-1.amazonaws.com' If not provided, GoldenGate will default to '

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 37

def endpoint
  @endpoint
end

#region ⇒ String

The name of the AWS region where the bucket is created. If not provided, GoldenGate will default to 'us-west-2'. Note: this property will become mandatory after May 20, 2026.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 44

def region
  @region
end

#secret_access_key ⇒ String

Secret access key to access the Amazon S3 bucket. e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 24

def secret_access_key
  @secret_access_key
end

#secret_access_key_secret_id ⇒ String

The OCID of the Secret where the Secret Access Key is stored. Note: When provided, 'secretAccessKey' field must not be provided.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 30

def secret_access_key_secret_id
  @secret_access_key_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'security_attributes': :'securityAttributes',
    'access_key_id': :'accessKeyId',
    'secret_access_key': :'secretAccessKey',
    'secret_access_key_secret_id': :'secretAccessKeySecretId',
    'endpoint': :'endpoint',
    'region': :'region'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'access_key_id': :'String',
    'secret_access_key': :'String',
    'secret_access_key_secret_id': :'String',
    'endpoint': :'String',
    'region': :'String'
    # 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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 158

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    security_attributes == other.security_attributes &&
    access_key_id == other.access_key_id &&
    secret_access_key == other.secret_access_key &&
    secret_access_key_secret_id == other.secret_access_key_secret_id &&
    endpoint == other.endpoint &&
    region == other.region
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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 204

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


184
185
186
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 184

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



193
194
195
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 193

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, security_attributes, access_key_id, secret_access_key, secret_access_key_secret_id, endpoint, region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 237

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



231
232
233
 
# File 'lib/oci/golden_gate/models/update_amazon_s3_connection_details.rb', line 231

def to_s
  to_hash.to_s
end