software.amazon.awscdk.services.config

Interface CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty

All Known Implementing Classes:

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Jsii$Proxy

Enclosing class:

CfnOrganizationConfigRule

public static interface CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty

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 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.
default java.lang.String	getMaximumExecutionFrequency() The maximum frequency with which AWS Config runs evaluations 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.
java.lang.String	getRuleIdentifier() For organization config managed rules, a predefined identifier from a list.
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.

Method Detail

getRuleIdentifier

java.lang.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

default java.lang.String getDescription()

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

getInputParameters

default java.lang.String getInputParameters()

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

getMaximumExecutionFrequency

default java.lang.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

default java.lang.String getResourceIdScope()

The ID of the AWS resource that was evaluated.

getResourceTypesScope

default java.util.List<java.lang.String> getResourceTypesScope()

The type of the AWS resource that was evaluated.

getTagKeyScope

default java.lang.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

default java.lang.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

static CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder builder()

Returns:

a CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder of CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty