Class: Akeyless::RotatedSecretCreateAws

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RotatedSecretCreateAws

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 178

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::RotatedSecretCreateAws` 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::RotatedSecretCreateAws`. 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?(:'api_id')
    self.api_id = attributes[:'api_id']
  end

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

  if attributes.key?(:'authentication_credentials')
    self.authentication_credentials = attributes[:'authentication_credentials']
  else
    self.authentication_credentials = 'use-user-creds'
  end

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

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

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

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

  if attributes.key?(:'grace_rotation')
    self.grace_rotation = attributes[:'grace_rotation']
  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?(:'password_length')
    self.password_length = attributes[:'password_length']
  end

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

  if attributes.key?(:'rotation_event_in')
    if (value = attributes[:'rotation_event_in']).is_a?(Array)
      self.rotation_event_in = value
    end
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

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

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

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

Instance Attribute Details

#api_id ⇒ Object

API ID to rotate (relevant only for rotator-type=api-key)



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

def api_id
  @api_id
end

#api_key ⇒ Object

API key to rotate (relevant only for rotator-type=api-key)



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

def api_key
  @api_key
end

#authentication_credentials ⇒ Object

The credentials to connect with use-user-creds/use-target-creds



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

def authentication_credentials
  @authentication_credentials
end

#auto_rotate ⇒ Object

Whether to automatically rotate every –rotation-interval days, or disable existing automatic rotation [true/false]



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

def auto_rotate
  @auto_rotate
end

#aws_region ⇒ Object

Aws Region



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

def aws_region
  @aws_region
end

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]



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

def delete_protection
  @delete_protection
end

#description ⇒ Object

Description of the object



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

def description
  @description
end

#grace_rotation ⇒ Object

Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]



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

def grace_rotation
  @grace_rotation
end

#json ⇒ Object

Set output format to JSON



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

def json
  @json
end

#key ⇒ Object

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



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

def key
  @key
end

#max_versions ⇒ Object

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



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

def max_versions
  @max_versions
end

#name ⇒ Object

Rotated secret name



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

def name
  @name
end

#password_length ⇒ Object

The length of the password to be generated



55
56
57
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 55

def password_length
  @password_length
end

#rotate_after_disconnect ⇒ Object

Rotate the value of the secret after SRA session ends [true/false]



58
59
60
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 58

def rotate_after_disconnect
  @rotate_after_disconnect
end

#rotation_event_in ⇒ Object

How many days before the rotation of the item would you like to be notified



61
62
63
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 61

def rotation_event_in
  @rotation_event_in
end

#rotation_hour ⇒ Object

The Hour of the rotation in UTC



64
65
66
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 64

def rotation_hour
  @rotation_hour
end

#rotation_interval ⇒ Object

The number of days to wait between every automatic key rotation (1-365)



67
68
69
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 67

def rotation_interval
  @rotation_interval
end

#rotator_type ⇒ Object

The rotator type. options: [target/api-key]



70
71
72
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 70

def rotator_type
  @rotator_type
end

#secure_access_aws_account_id ⇒ Object

The AWS account id



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

def 
  @secure_access_aws_account_id
end

#secure_access_aws_native_cli ⇒ Object

The AWS native cli



76
77
78
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 76

def secure_access_aws_native_cli
  @secure_access_aws_native_cli
end

#secure_access_bastion_issuer ⇒ Object

Deprecated. use secure-access-certificate-issuer



79
80
81
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 79

def secure_access_bastion_issuer
  @secure_access_bastion_issuer
end

#secure_access_certificate_issuer ⇒ Object

Path to the SSH Certificate Issuer for your Akeyless Secure Access



82
83
84
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 82

def secure_access_certificate_issuer
  @secure_access_certificate_issuer
end

#secure_access_enable ⇒ Object

Enable/Disable secure remote access [true/false]



85
86
87
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 85

def secure_access_enable
  @secure_access_enable
end

#tags ⇒ Object

Add tags attached to this object



88
89
90
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 88

def tags
  @tags
end

#target_name ⇒ Object

Target name



91
92
93
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 91

def target_name
  @target_name
end

#token ⇒ Object

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



94
95
96
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 94

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



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

def uid_token
  @uid_token
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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 421

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



133
134
135
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 133

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
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
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 100

def self.attribute_map
  {
    :'api_id' => :'api-id',
    :'api_key' => :'api-key',
    :'authentication_credentials' => :'authentication-credentials',
    :'auto_rotate' => :'auto-rotate',
    :'aws_region' => :'aws-region',
    :'delete_protection' => :'delete_protection',
    :'description' => :'description',
    :'grace_rotation' => :'grace-rotation',
    :'json' => :'json',
    :'key' => :'key',
    :'max_versions' => :'max-versions',
    :'name' => :'name',
    :'password_length' => :'password-length',
    :'rotate_after_disconnect' => :'rotate-after-disconnect',
    :'rotation_event_in' => :'rotation-event-in',
    :'rotation_hour' => :'rotation-hour',
    :'rotation_interval' => :'rotation-interval',
    :'rotator_type' => :'rotator-type',
    :'secure_access_aws_account_id' => :'secure-access-aws-account-id',
    :'secure_access_aws_native_cli' => :'secure-access-aws-native-cli',
    :'secure_access_bastion_issuer' => :'secure-access-bastion-issuer',
    :'secure_access_certificate_issuer' => :'secure-access-certificate-issuer',
    :'secure_access_enable' => :'secure-access-enable',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token'
  }
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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 397

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



171
172
173
174
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 171

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 138

def self.openapi_types
  {
    :'api_id' => :'String',
    :'api_key' => :'String',
    :'authentication_credentials' => :'String',
    :'auto_rotate' => :'String',
    :'aws_region' => :'String',
    :'delete_protection' => :'String',
    :'description' => :'String',
    :'grace_rotation' => :'String',
    :'json' => :'Boolean',
    :'key' => :'String',
    :'max_versions' => :'String',
    :'name' => :'String',
    :'password_length' => :'String',
    :'rotate_after_disconnect' => :'String',
    :'rotation_event_in' => :'Array<String>',
    :'rotation_hour' => :'Integer',
    :'rotation_interval' => :'String',
    :'rotator_type' => :'String',
    :'secure_access_aws_account_id' => :'String',
    :'secure_access_aws_native_cli' => :'Boolean',
    :'secure_access_bastion_issuer' => :'String',
    :'secure_access_certificate_issuer' => :'String',
    :'secure_access_enable' => :'String',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 350

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_id == o.api_id &&
      api_key == o.api_key &&
      authentication_credentials == o.authentication_credentials &&
      auto_rotate == o.auto_rotate &&
      aws_region == o.aws_region &&
      delete_protection == o.delete_protection &&
      description == o.description &&
      grace_rotation == o.grace_rotation &&
      json == o.json &&
      key == o.key &&
      max_versions == o.max_versions &&
      name == o.name &&
      password_length == o.password_length &&
      rotate_after_disconnect == o.rotate_after_disconnect &&
      rotation_event_in == o.rotation_event_in &&
      rotation_hour == o.rotation_hour &&
      rotation_interval == o.rotation_interval &&
      rotator_type == o.rotator_type &&
       == o. &&
      secure_access_aws_native_cli == o.secure_access_aws_native_cli &&
      secure_access_bastion_issuer == o.secure_access_bastion_issuer &&
      secure_access_certificate_issuer == o.secure_access_certificate_issuer &&
      secure_access_enable == o.secure_access_enable &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token
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



492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 492

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


384
385
386
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 384

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



390
391
392
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 390

def hash
  [api_id, api_key, authentication_credentials, auto_rotate, aws_region, delete_protection, description, grace_rotation, json, key, max_versions, name, password_length, rotate_after_disconnect, rotation_event_in, rotation_hour, rotation_interval, rotator_type, , secure_access_aws_native_cli, secure_access_bastion_issuer, secure_access_certificate_issuer, secure_access_enable, tags, target_name, token, uid_token].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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 320

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

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

  if @target_name.nil?
    invalid_properties.push('invalid value for "target_name", target_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



468
469
470
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 468

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



474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 474

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



462
463
464
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 462

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



340
341
342
343
344
345
346
 
# File 'lib/akeyless/models/rotated_secret_create_aws.rb', line 340

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