public static interface CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Builder
|
static class |
CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Jsii$Proxy
An implementation for
CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty |
Modifier and Type | Method and Description |
---|---|
static CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Builder |
builder() |
default java.lang.String |
getDescription()
The description that you provide for your organization AWS Config rule.
|
default java.lang.String |
getInputParameters()
A string, in JSON format, that is passed to your organization AWS Config rule Lambda function.
|
java.lang.String |
getLambdaFunctionArn()
The lambda function ARN.
|
default java.lang.String |
getMaximumExecutionFrequency()
The maximum frequency with which AWS Config runs evaluations for a rule.
|
java.util.List<java.lang.String> |
getOrganizationConfigRuleTriggerTypes()
The type of notification that triggers AWS Config to run an evaluation for a rule.
|
default java.lang.String |
getResourceIdScope()
The ID of the AWS resource that was evaluated.
|
default java.util.List<java.lang.String> |
getResourceTypesScope()
The type of the AWS resource that was evaluated.
|
default java.lang.String |
getTagKeyScope()
One part of a key-value pair that make up a tag.
|
default java.lang.String |
getTagValueScope()
The optional part of a key-value pair that make up a tag.
|
java.lang.String getLambdaFunctionArn()
java.util.List<java.lang.String> getOrganizationConfigRuleTriggerTypes()
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
.default java.lang.String getDescription()
default java.lang.String getInputParameters()
default java.lang.String getMaximumExecutionFrequency()
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.
default java.lang.String getResourceIdScope()
default java.util.List<java.lang.String> getResourceTypesScope()
default java.lang.String getTagKeyScope()
A key is a general label that acts like a category for more specific tag values.
default java.lang.String getTagValueScope()
A value acts as a descriptor within a tag category (key).