Package software.amazon.awscdk.cfnpropertymixins.services.config

Class CfnOrganizationConfigRulePropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.config.CfnOrganizationConfigRulePropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.509Z") @Stability(Stable) public class CfnOrganizationConfigRulePropsMixin extends Mixin implements software.constructs.IMixin
Adds or updates an AWS Config rule for your entire organization to evaluate if your AWS resources comply with your desired configurations.

For information on how many organization AWS Config rules you can have per account, see Service Limits in the AWS Config Developer Guide .

Only a management account and a delegated administrator can create or update an organization AWS Config rule. When calling the OrganizationConfigRule resource with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.

The OrganizationConfigRule resource enables organization service access through the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. AWS Config verifies the existence of role with GetRole action.

To use the OrganizationConfigRule resource with delegated administrator, register a delegated administrator by calling AWS Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com .

There are two types of rules: AWS Config Managed Rules and AWS Config Custom Rules . You can use PutOrganizationConfigRule to create both AWS Config Managed Rules and AWS Config Custom Rules.

AWS Config Managed Rules are predefined, customizable rules created by AWS Config . For a list of managed rules, see List of AWS Config Managed Rules . If you are adding an AWS Config managed rule, you must specify the rule's identifier for the RuleIdentifier key.

AWS Config Custom Rules are rules that you create from scratch. There are two ways to create AWS Config custom rules: with Lambda functions ( AWS Lambda Developer Guide ) and with Guard ( Guard GitHub Repository ), a policy-as-code language. AWS Config custom rules created with AWS Lambda are called AWS Config Custom Lambda Rules and AWS Config custom rules created with Guard are called AWS Config Custom Policy Rules .

If you are adding a new AWS Config Custom Lambda rule, you first need to create an AWS Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use PutOrganizationConfigRule to add a Custom Lambda rule to AWS Config , you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.config.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnOrganizationConfigRulePropsMixin cfnOrganizationConfigRulePropsMixin = CfnOrganizationConfigRulePropsMixin.Builder.create(CfnOrganizationConfigRuleMixinProps.builder()
         .excludedAccounts(List.of("excludedAccounts"))
         .organizationConfigRuleName("organizationConfigRuleName")
         .organizationCustomPolicyRuleMetadata(OrganizationCustomPolicyRuleMetadataProperty.builder()
                 .debugLogDeliveryAccounts(List.of("debugLogDeliveryAccounts"))
                 .description("description")
                 .inputParameters("inputParameters")
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .organizationConfigRuleTriggerTypes(List.of("organizationConfigRuleTriggerTypes"))
                 .policyText("policyText")
                 .resourceIdScope("resourceIdScope")
                 .resourceTypesScope(List.of("resourceTypesScope"))
                 .runtime("runtime")
                 .tagKeyScope("tagKeyScope")
                 .tagValueScope("tagValueScope")
                 .build())
         .organizationCustomRuleMetadata(OrganizationCustomRuleMetadataProperty.builder()
                 .description("description")
                 .inputParameters("inputParameters")
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .organizationConfigRuleTriggerTypes(List.of("organizationConfigRuleTriggerTypes"))
                 .resourceIdScope("resourceIdScope")
                 .resourceTypesScope(List.of("resourceTypesScope"))
                 .tagKeyScope("tagKeyScope")
                 .tagValueScope("tagValueScope")
                 .build())
         .organizationManagedRuleMetadata(OrganizationManagedRuleMetadataProperty.builder()
                 .description("description")
                 .inputParameters("inputParameters")
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .resourceIdScope("resourceIdScope")
                 .resourceTypesScope(List.of("resourceTypesScope"))
                 .ruleIdentifier("ruleIdentifier")
                 .tagKeyScope("tagKeyScope")
                 .tagValueScope("tagValueScope")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnOrganizationConfigRulePropsMixin

      protected CfnOrganizationConfigRulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOrganizationConfigRulePropsMixin

      protected CfnOrganizationConfigRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOrganizationConfigRulePropsMixin

      @Stability(Stable) public CfnOrganizationConfigRulePropsMixin(@NotNull CfnOrganizationConfigRuleMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Config::OrganizationConfigRule.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnOrganizationConfigRulePropsMixin

      @Stability(Stable) public CfnOrganizationConfigRulePropsMixin(@NotNull CfnOrganizationConfigRuleMixinProps props)
      Create a mixin to apply properties to AWS::Config::OrganizationConfigRule.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnOrganizationConfigRuleMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()