aws-cdk-lib.aws_config.CfnOrganizationConfigRuleProps

interface CfnOrganizationConfigRuleProps

LanguageType name
.NETAmazon.CDK.AWS.Config.CfnOrganizationConfigRuleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsconfig#CfnOrganizationConfigRuleProps
Javasoftware.amazon.awscdk.services.config.CfnOrganizationConfigRuleProps
Pythonaws_cdk.aws_config.CfnOrganizationConfigRuleProps
TypeScript aws-cdk-lib » aws_config » CfnOrganizationConfigRuleProps

Properties for defining a CfnOrganizationConfigRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_config as config } from 'aws-cdk-lib';
const cfnOrganizationConfigRuleProps: config.CfnOrganizationConfigRuleProps = {
  organizationConfigRuleName: 'organizationConfigRuleName',

  // the properties below are optional
  excludedAccounts: ['excludedAccounts'],
  organizationCustomPolicyRuleMetadata: {
    policyText: 'policyText',
    runtime: 'runtime',

    // the properties below are optional
    debugLogDeliveryAccounts: ['debugLogDeliveryAccounts'],
    description: 'description',
    inputParameters: 'inputParameters',
    maximumExecutionFrequency: 'maximumExecutionFrequency',
    organizationConfigRuleTriggerTypes: ['organizationConfigRuleTriggerTypes'],
    resourceIdScope: 'resourceIdScope',
    resourceTypesScope: ['resourceTypesScope'],
    tagKeyScope: 'tagKeyScope',
    tagValueScope: 'tagValueScope',
  },
  organizationCustomRuleMetadata: {
    lambdaFunctionArn: 'lambdaFunctionArn',
    organizationConfigRuleTriggerTypes: ['organizationConfigRuleTriggerTypes'],

    // the properties below are optional
    description: 'description',
    inputParameters: 'inputParameters',
    maximumExecutionFrequency: 'maximumExecutionFrequency',
    resourceIdScope: 'resourceIdScope',
    resourceTypesScope: ['resourceTypesScope'],
    tagKeyScope: 'tagKeyScope',
    tagValueScope: 'tagValueScope',
  },
  organizationManagedRuleMetadata: {
    ruleIdentifier: 'ruleIdentifier',

    // the properties below are optional
    description: 'description',
    inputParameters: 'inputParameters',
    maximumExecutionFrequency: 'maximumExecutionFrequency',
    resourceIdScope: 'resourceIdScope',
    resourceTypesScope: ['resourceTypesScope'],
    tagKeyScope: 'tagKeyScope',
    tagValueScope: 'tagValueScope',
  },
};

Properties

NameTypeDescription
organizationConfigRuleNamestringThe name that you assign to organization AWS Config rule.
excludedAccounts?string[]A comma-separated list of accounts excluded from organization AWS Config rule.
organizationCustomPolicyRuleMetadata?IResolvable | OrganizationCustomPolicyRuleMetadataPropertyAWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata.
organizationCustomRuleMetadata?IResolvable | OrganizationCustomRuleMetadataPropertyAn OrganizationCustomRuleMetadata object.
organizationManagedRuleMetadata?IResolvable | OrganizationManagedRuleMetadataPropertyAn OrganizationManagedRuleMetadata object.

organizationConfigRuleName

Type: string

The name that you assign to organization AWS Config rule.


excludedAccounts?

Type: string[] (optional)

A comma-separated list of accounts excluded from organization AWS Config rule.


organizationCustomPolicyRuleMetadata?

Type: IResolvable | OrganizationCustomPolicyRuleMetadataProperty (optional)

AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata.


organizationCustomRuleMetadata?

Type: IResolvable | OrganizationCustomRuleMetadataProperty (optional)

An OrganizationCustomRuleMetadata object.


organizationManagedRuleMetadata?

Type: IResolvable | OrganizationManagedRuleMetadataProperty (optional)

An OrganizationManagedRuleMetadata object.