AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing OrganizationManagedRuleMetadata as input to an Aws::Client method, you can use a vanilla Hash:

{
  description: "StringWithCharLimit256Min0",
  rule_identifier: "StringWithCharLimit256", # required
  input_parameters: "StringWithCharLimit2048",
  maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
  resource_types_scope: ["StringWithCharLimit256"],
  resource_id_scope: "StringWithCharLimit768",
  tag_key_scope: "StringWithCharLimit128",
  tag_value_scope: "StringWithCharLimit256",
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description that you provide for organization config rule.

Returns:

  • (String)

    The description that you provide for organization config rule.

#input_parametersString

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

Returns:

  • (String)

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

#maximum_execution_frequencyString

The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Possible values:

  • One_Hour
  • Three_Hours
  • Six_Hours
  • Twelve_Hours
  • TwentyFour_Hours

Returns:

  • (String)

    The maximum frequency with which AWS Config runs evaluations for a rule.

#resource_id_scopeString

The ID of the AWS resource that was evaluated.

Returns:

  • (String)

    The ID of the AWS resource that was evaluated.

#resource_types_scopeArray<String>

The type of the AWS resource that was evaluated.

Returns:

  • (Array<String>)

    The type of the AWS resource that was evaluated.

#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 AWS Managed Config Rules.

Returns:

  • (String)

    For organization config managed rules, a predefined identifier from a list.

#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)

    One part of a key-value pair that make up a tag.

#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)

    The optional part of a key-value pair that make up a tag.