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

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

Overview

Note:

When making an API call, you may pass OrganizationCustomRuleMetadata data as a hash:

{
  description: "StringWithCharLimit256Min0",
  lambda_function_arn: "StringWithCharLimit256", # required
  organization_config_rule_trigger_types: ["ConfigurationItemChangeNotification"], # required, accepts ConfigurationItemChangeNotification, OversizedConfigurationItemChangeNotification, ScheduledNotification
  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 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

#descriptionString

The description that you provide for organization config rule.

Returns:

  • (String)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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_parametersString

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

Returns:

  • (String)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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_arnString

The lambda function ARN.

Returns:

  • (String)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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_frequencyString

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)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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_scopeString

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

Returns:

  • (String)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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_scopeArray<String>

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

Returns:

  • (Array<String>)


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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


6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6142

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