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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.579Z")
@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();
 

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()	AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata.
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.

getExcludedAccounts

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

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

getOrganizationCustomPolicyRuleMetadata

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

AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata.

getOrganizationCustomRuleMetadata

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

An OrganizationCustomRuleMetadata object.

getOrganizationManagedRuleMetadata

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

An OrganizationManagedRuleMetadata object.

builder

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

Returns:

a CfnOrganizationConfigRuleProps.Builder of CfnOrganizationConfigRuleProps