Package software.amazon.awscdk.services.config

Interface CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Jsii$Proxy
Enclosing class:
CfnOrganizationConfigRule
@Stability(Stable) public static interface CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty extends software.amazon.jsii.JsiiSerializable
organization custom rule metadata such as resource type, resource ID of AWS resource, Lambda function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule.

It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.config.*;
 OrganizationCustomRuleMetadataProperty organizationCustomRuleMetadataProperty = OrganizationCustomRuleMetadataProperty.builder()
         .lambdaFunctionArn("lambdaFunctionArn")
         .organizationConfigRuleTriggerTypes(List.of("organizationConfigRuleTriggerTypes"))
         // the properties below are optional
         .description("description")
         .inputParameters("inputParameters")
         .maximumExecutionFrequency("maximumExecutionFrequency")
         .resourceIdScope("resourceIdScope")
         .resourceTypesScope(List.of("resourceTypesScope"))
         .tagKeyScope("tagKeyScope")
         .tagValueScope("tagValueScope")
         .build();

  • Method Details

    • getLambdaFunctionArn

      @Stability(Stable) @NotNull String getLambdaFunctionArn()
      The lambda function ARN.

    • getOrganizationConfigRuleTriggerTypes

      @Stability(Stable) @NotNull List<String> getOrganizationConfigRuleTriggerTypes()
      The type of notification that triggers AWS Config to run an evaluation for a rule.

      You can specify the following notification types:

      • ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.
      • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS 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 .

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description that you provide for your organization AWS Config rule.

    • getInputParameters

      @Stability(Stable) @Nullable default String getInputParameters()
      A string, in JSON format, that is passed to your organization AWS Config rule Lambda function.

    • getMaximumExecutionFrequency

      @Stability(Stable) @Nullable default String getMaximumExecutionFrequency()
      The maximum frequency with which AWS Config runs evaluations for a rule.

      Your custom rule is triggered when AWS 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.

    • getResourceIdScope

      @Stability(Stable) @Nullable default String getResourceIdScope()
      The ID of the AWS resource that was evaluated.

    • getResourceTypesScope

      @Stability(Stable) @Nullable default List<String> getResourceTypesScope()
      The type of the AWS resource that was evaluated.

    • getTagKeyScope

      @Stability(Stable) @Nullable default String getTagKeyScope()
      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.

    • getTagValueScope

      @Stability(Stable) @Nullable default String getTagValueScope()
      The optional part of a key-value pair that make up a tag.

      A value acts as a descriptor within a tag category (key).

    • builder

      @Stability(Stable) static CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Builder builder()
      Returns:
      a CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Builder of CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty