Class: Aws::ConfigService::Types::OrganizationManagedRuleMetadata

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-configservice/types.rb

Overview

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description that you provide for your organization Config rule.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#input_parametersString

A string, in JSON format, that is passed to your organization Config rule Lambda function.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_execution_frequencyString

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

<note markdown=“1”> By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the ‘MaximumExecutionFrequency` parameter.

</note>

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id_scopeString

The ID of the Amazon Web Services resource that was evaluated.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#resource_types_scopeArray<String>

The type of the Amazon Web Services resource that was evaluated.

Returns:

  • (Array<String>)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#rule_identifierString

For organization config managed rules, a predefined identifier from a list. For example, ‘IAM_PASSWORD_POLICY` is a managed rule. To reference a managed rule, see [Using Config managed rules].

[1]: docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key_scopeString

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end

#tag_value_scopeString

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Returns:

  • (String)


6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
# File 'lib/aws-sdk-configservice/types.rb', line 6301

class OrganizationManagedRuleMetadata < Struct.new(
  :description,
  :rule_identifier,
  :input_parameters,
  :maximum_execution_frequency,
  :resource_types_scope,
  :resource_id_scope,
  :tag_key_scope,
  :tag_value_scope)
  SENSITIVE = []
  include Aws::Structure
end