Package software.amazon.awscdk.services.config

Interface CfnOrganizationConfigRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOrganizationConfigRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:29.636Z")
@Stability(Stable)
public interface CfnOrganizationConfigRuleProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.config.*;
 CfnOrganizationConfigRuleProps cfnOrganizationConfigRuleProps = CfnOrganizationConfigRuleProps.builder()
         .organizationConfigRuleName("organizationConfigRuleName")
         // the properties below are optional
         .excludedAccounts(List.of("excludedAccounts"))
         .organizationCustomPolicyRuleMetadata(OrganizationCustomPolicyRuleMetadataProperty.builder()
                 .policyText("policyText")
                 .runtime("runtime")
                 // the properties below are optional
                 .debugLogDeliveryAccounts(List.of("debugLogDeliveryAccounts"))
                 .description("description")
                 .inputParameters("inputParameters")
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .organizationConfigRuleTriggerTypes(List.of("organizationConfigRuleTriggerTypes"))
                 .resourceIdScope("resourceIdScope")
                 .resourceTypesScope(List.of("resourceTypesScope"))
                 .tagKeyScope("tagKeyScope")
                 .tagValueScope("tagValueScope")
                 .build())
         .organizationCustomRuleMetadata(OrganizationCustomRuleMetadataProperty.builder()
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .organizationConfigRuleTriggerTypes(List.of("organizationConfigRuleTriggerTypes"))
                 // the properties below are optional
                 .description("description")
                 .inputParameters("inputParameters")
                 .maximumExecutionFrequency("maximumExecutionFrequency")
                 .resourceIdScope("resourceIdScope")
                 .resourceTypesScope(List.of("resourceTypesScope"))
                 .tagKeyScope("tagKeyScope")
                 .tagValueScope("tagValueScope")
                 .build())
         .organizationManagedRuleMetadata(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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnOrganizationConfigRuleProps.Builder	builder()
default List<String>	getExcludedAccounts()	A comma-separated list of accounts excluded from organization AWS Config rule.
String	getOrganizationConfigRuleName()	The name that you assign to organization AWS Config rule.
default Object	getOrganizationCustomPolicyRuleMetadata()	An object that specifies metadata for your organization's AWS Config Custom Policy rule.
default Object	getOrganizationCustomRuleMetadata()	An OrganizationCustomRuleMetadata object.
default Object	getOrganizationManagedRuleMetadata()	An OrganizationManagedRuleMetadata object.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getOrganizationConfigRuleName

@Stability(Stable)
@NotNull
String getOrganizationConfigRuleName()

The name that you assign to organization AWS Config rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationconfigrulename

getExcludedAccounts

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-excludedaccounts

getOrganizationCustomPolicyRuleMetadata

@Stability(Stable)
@Nullable
default Object getOrganizationCustomPolicyRuleMetadata()

An object that specifies metadata for your organization's AWS Config Custom Policy rule.

The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustompolicyrulemetadata

getOrganizationCustomRuleMetadata

@Stability(Stable)
@Nullable
default Object getOrganizationCustomRuleMetadata()

An OrganizationCustomRuleMetadata object.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata

getOrganizationManagedRuleMetadata

@Stability(Stable)
@Nullable
default Object getOrganizationManagedRuleMetadata()

An OrganizationManagedRuleMetadata object.

See Also:

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

builder

@Stability(Stable)
static CfnOrganizationConfigRuleProps.Builder builder()

Returns:

a CfnOrganizationConfigRuleProps.Builder of CfnOrganizationConfigRuleProps