software.amazon.awscdk.services.config

Class CfnConfigRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.config.CfnConfigRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.691Z")
 @Stability(value=Stable)
public class CfnConfigRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Config::ConfigRule`.

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.*;
 Object inputParameters;
 CfnConfigRule cfnConfigRule = CfnConfigRule.Builder.create(this, "MyCfnConfigRule")
         .source(SourceProperty.builder()
                 .owner("owner")
                 .sourceIdentifier("sourceIdentifier")
                 // the properties below are optional
                 .sourceDetails(List.of(SourceDetailProperty.builder()
                         .eventSource("eventSource")
                         .messageType("messageType")
                         // the properties below are optional
                         .maximumExecutionFrequency("maximumExecutionFrequency")
                         .build()))
                 .build())
         // the properties below are optional
         .configRuleName("configRuleName")
         .description("description")
         .inputParameters(inputParameters)
         .maximumExecutionFrequency("maximumExecutionFrequency")
         .scope(ScopeProperty.builder()
                 .complianceResourceId("complianceResourceId")
                 .complianceResourceTypes(List.of("complianceResourceTypes"))
                 .tagKey("tagKey")
                 .tagValue("tagValue")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfigRule.Builder A fluent builder for CfnConfigRule.
static interface	CfnConfigRule.ScopeProperty Example:
static interface	CfnConfigRule.SourceDetailProperty Example:
static interface	CfnConfigRule.SourceProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfigRule(software.constructs.Construct scope, String id, CfnConfigRuleProps props) Create a new `AWS::Config::ConfigRule`.
protected	CfnConfigRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrComplianceType()
String	getAttrConfigRuleId()
protected Map<String,Object>	getCfnProperties()
String	getConfigRuleName() `AWS::Config::ConfigRule.ConfigRuleName`.
String	getDescription() `AWS::Config::ConfigRule.Description`.
Object	getInputParameters() `AWS::Config::ConfigRule.InputParameters`.
String	getMaximumExecutionFrequency() `AWS::Config::ConfigRule.MaximumExecutionFrequency`.
Object	getScope() `AWS::Config::ConfigRule.Scope`.
Object	getSource() `AWS::Config::ConfigRule.Source`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfigRuleName(String value) `AWS::Config::ConfigRule.ConfigRuleName`.
void	setDescription(String value) `AWS::Config::ConfigRule.Description`.
void	setInputParameters(Object value) `AWS::Config::ConfigRule.InputParameters`.
void	setMaximumExecutionFrequency(String value) `AWS::Config::ConfigRule.MaximumExecutionFrequency`.
void	setScope(CfnConfigRule.ScopeProperty value) `AWS::Config::ConfigRule.Scope`.
void	setScope(IResolvable value) `AWS::Config::ConfigRule.Scope`.
void	setSource(CfnConfigRule.SourceProperty value) `AWS::Config::ConfigRule.Source`.
void	setSource(IResolvable value) `AWS::Config::ConfigRule.Source`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfigRule

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

CfnConfigRule

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

CfnConfigRule

@Stability(value=Stable)
public CfnConfigRule(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnConfigRuleProps props)

Create a new `AWS::Config::ConfigRule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrComplianceType

@Stability(value=Stable)
 @NotNull
public String getAttrComplianceType()

getAttrConfigRuleId

@Stability(value=Stable)
 @NotNull
public String getAttrConfigRuleId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigRuleName

@Stability(value=Stable)
 @Nullable
public String getConfigRuleName()

`AWS::Config::ConfigRule.ConfigRuleName`.

setConfigRuleName

@Stability(value=Stable)
public void setConfigRuleName(@Nullable
                                                       String value)

`AWS::Config::ConfigRule.ConfigRuleName`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::Config::ConfigRule.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::Config::ConfigRule.Description`.

getInputParameters

@Stability(value=Stable)
 @NotNull
public Object getInputParameters()

`AWS::Config::ConfigRule.InputParameters`.

setInputParameters

@Stability(value=Stable)
public void setInputParameters(@NotNull
                                                        Object value)

`AWS::Config::ConfigRule.InputParameters`.

getMaximumExecutionFrequency

@Stability(value=Stable)
 @Nullable
public String getMaximumExecutionFrequency()

`AWS::Config::ConfigRule.MaximumExecutionFrequency`.

setMaximumExecutionFrequency

@Stability(value=Stable)
public void setMaximumExecutionFrequency(@Nullable
                                                                  String value)

`AWS::Config::ConfigRule.MaximumExecutionFrequency`.

getScope

@Stability(value=Stable)
 @Nullable
public Object getScope()

`AWS::Config::ConfigRule.Scope`.

setScope

@Stability(value=Stable)
public void setScope(@Nullable
                                              CfnConfigRule.ScopeProperty value)

`AWS::Config::ConfigRule.Scope`.

setScope

@Stability(value=Stable)
public void setScope(@Nullable
                                              IResolvable value)

`AWS::Config::ConfigRule.Scope`.

getSource

@Stability(value=Stable)
 @NotNull
public Object getSource()

`AWS::Config::ConfigRule.Source`.

setSource

@Stability(value=Stable)
public void setSource(@NotNull
                                               CfnConfigRule.SourceProperty value)

`AWS::Config::ConfigRule.Source`.

setSource

@Stability(value=Stable)
public void setSource(@NotNull
                                               IResolvable value)

`AWS::Config::ConfigRule.Source`.