Class: DatadogAPIClient::V1::AWSAccount

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/aws_account.rb

Overview

Returns the AWS account associated with this integration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 23

def _unparsed
  @_unparsed
end

#access_key_id ⇒ Object

Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 26

def access_key_id
  @access_key_id
end

#account_id ⇒ Object

Your AWS Account ID without dashes.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 29

def 
  @account_id
end

#account_specific_namespace_rules ⇒ Object

An object, (in the form {"namespace1":true/false, "namespace2":true/false}), that enables or disables metric collection for specific AWS namespaces for this AWS account only.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 32

def 
  @account_specific_namespace_rules
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



69
70
71
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 69

def additional_properties
  @additional_properties
end

#cspm_resource_collection_enabled ⇒ Object

Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general resource_collection.



35
36
37
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 35

def cspm_resource_collection_enabled
  @cspm_resource_collection_enabled
end

#excluded_regions ⇒ Object

An array of AWS regions to exclude from metrics collection.



38
39
40
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 38

def excluded_regions
  @excluded_regions
end

#extended_resource_collection_enabled ⇒ Object

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.



43
44
45
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 43

def extended_resource_collection_enabled
  @extended_resource_collection_enabled
end

#filter_tags ⇒ Object

The array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. For example, env:production,instance-type:c1.*,!region:us-east-1



41
42
43
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 41

def filter_tags
  @filter_tags
end

#host_tags ⇒ Object

Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 44

def host_tags
  @host_tags
end

#metrics_collection_enabled ⇒ Object

Whether Datadog collects metrics for this AWS account.



47
48
49
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 47

def metrics_collection_enabled
  @metrics_collection_enabled
end

#resource_collection_enabled ⇒ Object

Deprecated in favor of 'extended_resource_collection_enabled'. Whether Datadog collects a standard set of resources from your AWS account.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 50

def resource_collection_enabled
  @resource_collection_enabled
end

#role_name ⇒ Object

Your Datadog role delegation name.



53
54
55
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 53

def role_name
  @role_name
end

#secret_access_key ⇒ Object

Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.



56
57
58
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 56

def secret_access_key
  @secret_access_key
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 76

def self.acceptable_attributes
  attribute_map.values
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



223
224
225
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 223

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 98

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

Instance 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



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
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 253

def _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 :Array
    # generic array, 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 = DatadogAPIClient::V1.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V1::UnparsedObject
      self._unparsed = true
    end
    res
  end
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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 331

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

#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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 230

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 210

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



179
180
181
182
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  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



307
308
309
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 307

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



301
302
303
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 301

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



186
187
188
 
# File 'lib/datadog_api_client/v1/models/aws_account.rb', line 186

def valid?
  true
end