Class: Akeyless::TargetCreateAws

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetCreateAws

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/akeyless/models/target_create_aws.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::TargetCreateAws` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::TargetCreateAws`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'access_key')
    self.access_key = attributes[:'access_key']
  else
    self.access_key = nil
  end

  if attributes.key?(:'access_key_id')
    self.access_key_id = attributes[:'access_key_id']
  else
    self.access_key_id = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'key')
    self.key = attributes[:'key']
  end

  if attributes.key?(:'max_versions')
    self.max_versions = attributes[:'max_versions']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'region')
    self.region = attributes[:'region']
  else
    self.region = 'us-east-2'
  end

  if attributes.key?(:'session_token')
    self.session_token = attributes[:'session_token']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end

  if attributes.key?(:'use_gw_cloud_identity')
    self.use_gw_cloud_identity = attributes[:'use_gw_cloud_identity']
  end
end

Instance Attribute Details

#access_key ⇒ Object

AWS secret access key



19
20
21
 
# File 'lib/akeyless/models/target_create_aws.rb', line 19

def access_key
  @access_key
end

#access_key_id ⇒ Object

AWS access key ID



22
23
24
 
# File 'lib/akeyless/models/target_create_aws.rb', line 22

def access_key_id
  @access_key_id
end

#description ⇒ Object

Description of the object



25
26
27
 
# File 'lib/akeyless/models/target_create_aws.rb', line 25

def description
  @description
end

#json ⇒ Object

Set output format to JSON



28
29
30
 
# File 'lib/akeyless/models/target_create_aws.rb', line 28

def json
  @json
end

#key ⇒ Object

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)



31
32
33
 
# File 'lib/akeyless/models/target_create_aws.rb', line 31

def key
  @key
end

#max_versions ⇒ Object

Set the maximum number of versions, limited by the account settings defaults.



34
35
36
 
# File 'lib/akeyless/models/target_create_aws.rb', line 34

def max_versions
  @max_versions
end

#name ⇒ Object

Target name



37
38
39
 
# File 'lib/akeyless/models/target_create_aws.rb', line 37

def name
  @name
end

#region ⇒ Object

AWS region



40
41
42
 
# File 'lib/akeyless/models/target_create_aws.rb', line 40

def region
  @region
end

#session_token ⇒ Object

Required only for temporary security credentials retrieved using STS



43
44
45
 
# File 'lib/akeyless/models/target_create_aws.rb', line 43

def session_token
  @session_token
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



46
47
48
 
# File 'lib/akeyless/models/target_create_aws.rb', line 46

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



49
50
51
 
# File 'lib/akeyless/models/target_create_aws.rb', line 49

def uid_token
  @uid_token
end

#use_gw_cloud_identity ⇒ Object

Use the GW’s Cloud IAM



52
53
54
 
# File 'lib/akeyless/models/target_create_aws.rb', line 52

def use_gw_cloud_identity
  @use_gw_cloud_identity
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/akeyless/models/target_create_aws.rb', line 263

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/akeyless/models/target_create_aws.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/akeyless/models/target_create_aws.rb', line 55

def self.attribute_map
  {
    :'access_key' => :'access-key',
    :'access_key_id' => :'access-key-id',
    :'description' => :'description',
    :'json' => :'json',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'region' => :'region',
    :'session_token' => :'session-token',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'use_gw_cloud_identity' => :'use-gw-cloud-identity'
  }
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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/akeyless/models/target_create_aws.rb', line 239

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/akeyless/models/target_create_aws.rb', line 96

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/akeyless/models/target_create_aws.rb', line 78

def self.openapi_types
  {
    :'access_key' => :'String',
    :'access_key_id' => :'String',
    :'description' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'region' => :'String',
    :'session_token' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'use_gw_cloud_identity' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/akeyless/models/target_create_aws.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_key == o.access_key &&
      access_key_id == o.access_key_id &&
      description == o.description &&
      json == o.json &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      region == o.region &&
      session_token == o.session_token &&
      token == o.token &&
      uid_token == o.uid_token &&
      use_gw_cloud_identity == o.use_gw_cloud_identity
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/akeyless/models/target_create_aws.rb', line 334

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/akeyless/models/target_create_aws.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/akeyless/models/target_create_aws.rb', line 232

def hash
  [access_key, access_key_id, description, json, key, max_versions, name, region, session_token, token, uid_token, use_gw_cloud_identity].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/akeyless/models/target_create_aws.rb', line 177

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @access_key.nil?
    invalid_properties.push('invalid value for "access_key", access_key cannot be nil.')
  end

  if @access_key_id.nil?
    invalid_properties.push('invalid value for "access_key_id", access_key_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



310
311
312
 
# File 'lib/akeyless/models/target_create_aws.rb', line 310

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/akeyless/models/target_create_aws.rb', line 316

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



304
305
306
 
# File 'lib/akeyless/models/target_create_aws.rb', line 304

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



197
198
199
200
201
202
203
 
# File 'lib/akeyless/models/target_create_aws.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @access_key.nil?
  return false if @access_key_id.nil?
  return false if @name.nil?
  true
end