software.amazon.awscdk.services.config

Interface CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Jsii$Proxy

Enclosing class:

CfnOrganizationConfigRule

@Stability(value=Stable)
public static interface CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty
extends software.amazon.jsii.JsiiSerializable

An object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier.

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.*;
 OrganizationManagedRuleMetadataProperty organizationManagedRuleMetadataProperty = OrganizationManagedRuleMetadataProperty.builder()
         .ruleIdentifier("ruleIdentifier")
         // the properties below are optional
         .description("description")
         .inputParameters("inputParameters")
         .maximumExecutionFrequency("maximumExecutionFrequency")
         .resourceIdScope("resourceIdScope")
         .resourceTypesScope(List.of("resourceTypesScope"))
         .tagKeyScope("tagKeyScope")
         .tagValueScope("tagValueScope")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder A builder for CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty
static class	CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Jsii$Proxy An implementation for CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty

Method Summary

Modifier and Type	Method and Description
static CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder	builder()
default String	getDescription() The description that you provide for your organization AWS Config rule.
default String	getInputParameters() A string, in JSON format, that is passed to your organization AWS Config rule Lambda function.
default String	getMaximumExecutionFrequency() The maximum frequency with which AWS Config runs evaluations for a rule.
default String	getResourceIdScope() The ID of the AWS resource that was evaluated.
default List<String>	getResourceTypesScope() The type of the AWS resource that was evaluated.
String	getRuleIdentifier() For organization config managed rules, a predefined identifier from a list.
default String	getTagKeyScope() One part of a key-value pair that make up a tag.
default String	getTagValueScope() The optional part of a key-value pair that make up a tag.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRuleIdentifier

@Stability(value=Stable)
 @NotNull
String getRuleIdentifier()

For organization config managed rules, a predefined identifier from a list.

For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Config managed rules .

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The description that you provide for your organization AWS Config rule.

getInputParameters

@Stability(value=Stable)
 @Nullable
default String getInputParameters()

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

getMaximumExecutionFrequency

@Stability(value=Stable)
 @Nullable
default String getMaximumExecutionFrequency()

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

You are using an AWS Config managed rule that is triggered at a periodic frequency.

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(value=Stable)
 @Nullable
default String getResourceIdScope()

The ID of the AWS resource that was evaluated.

getResourceTypesScope

@Stability(value=Stable)
 @Nullable
default List<String> getResourceTypesScope()

The type of the AWS resource that was evaluated.

getTagKeyScope

@Stability(value=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(value=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(value=Stable)
static CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder builder()

Returns:

a CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder of CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty