Package 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(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Details

getRuleIdentifier

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-ruleidentifier

getDescription

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-description

getInputParameters

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-inputparameters

getMaximumExecutionFrequency

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

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

This is for 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-maximumexecutionfrequency

getResourceIdScope

@Stability(Stable)
@Nullable
default String getResourceIdScope()

The ID of the AWS resource that was evaluated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourceidscope

getResourceTypesScope

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

The type of the AWS resource that was evaluated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourcetypesscope

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagkeyscope

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagvaluescope

builder

@Stability(Stable)
static CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder builder()

Returns:

a CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Builder of CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty