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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description that you provide for your organization Config rule.

Returns:

  • (String)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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.

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

Returns:

  • (String)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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)


7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 7243

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