Class: Aws::ConfigService::Types::OrganizationCustomRuleMetadata

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::OrganizationCustomRuleMetadata

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description that you provide for your organization Config rule.

• #input_parameters ⇒ String

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

• #lambda_function_arn ⇒ String

  The lambda function ARN.

• #maximum_execution_frequency ⇒ String

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

• #organization_config_rule_trigger_types ⇒ Array<String>

  The type of notification that triggers Config to run an evaluation for a rule.

• #resource_id_scope ⇒ String

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

• #resource_types_scope ⇒ Array<String>

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

• #tag_key_scope ⇒ String

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

• #tag_value_scope ⇒ String

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

Instance Attribute Details

#description ⇒ String

The description that you provide for your organization Config rule.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#input_parameters ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#lambda_function_arn ⇒ String

The lambda function ARN.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#maximum_execution_frequency ⇒ String

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

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

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#organization_config_rule_trigger_types ⇒ Array<String>

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

• ‘ConfigurationItemChangeNotification` - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

• ‘OversizedConfigurationItemChangeNotification` - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ‘ScheduledNotification` - Triggers a periodic evaluation at the frequency specified for `MaximumExecutionFrequency`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#resource_id_scope ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#resource_types_scope ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#tag_key_scope ⇒ String

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)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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

#tag_value_scope ⇒ String

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)

# File 'lib/aws-sdk-configservice/types.rb', line 6259

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