`configConfigRule` Submodule

Constructs

ConfigConfigRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule aws_config_config_rule}.

Initializers

import { configConfigRule } from '@cdktf/aws-cdk'

new configConfigRule.ConfigConfigRule(scope: Construct, id: string, config: ConfigConfigRuleConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`ConfigConfigRuleConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: ConfigConfigRuleConfig

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putScope`	No description.
`putSource`	No description.
`resetDescription`	No description.
`resetId`	No description.
`resetInputParameters`	No description.
`resetMaximumExecutionFrequency`	No description.
`resetScope`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putScope`

public putScope(value: ConfigConfigRuleScope): void

`value`^Required

Type: ConfigConfigRuleScope

`putSource`

public putSource(value: ConfigConfigRuleSource): void

`value`^Required

Type: ConfigConfigRuleSource

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetInputParameters`

public resetInputParameters(): void

`resetMaximumExecutionFrequency`

public resetMaximumExecutionFrequency(): void

`resetScope`

public resetScope(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a ConfigConfigRule resource upon running "cdktf plan ".

`isConstruct`

import { configConfigRule } from '@cdktf/aws-cdk'

configConfigRule.ConfigConfigRule.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { configConfigRule } from '@cdktf/aws-cdk'

configConfigRule.ConfigConfigRule.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { configConfigRule } from '@cdktf/aws-cdk'

configConfigRule.ConfigConfigRule.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { configConfigRule } from '@cdktf/aws-cdk'

configConfigRule.ConfigConfigRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ConfigConfigRule resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the ConfigConfigRule to import.

`importFromId`^Required

Type: string

The id of the existing ConfigConfigRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the ConfigConfigRule to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`arn`	`string`	No description.
`ruleId`	`string`	No description.
`scope`	`ConfigConfigRuleScopeOutputReference`	No description.
`source`	`ConfigConfigRuleSourceOutputReference`	No description.
`descriptionInput`	`string`	No description.
`idInput`	`string`	No description.
`inputParametersInput`	`string`	No description.
`maximumExecutionFrequencyInput`	`string`	No description.
`nameInput`	`string`	No description.
`scopeInput`	`ConfigConfigRuleScope`	No description.
`sourceInput`	`ConfigConfigRuleSource`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`description`	`string`	No description.
`id`	`string`	No description.
`inputParameters`	`string`	No description.
`maximumExecutionFrequency`	`string`	No description.
`name`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`ruleId`^Required

public readonly ruleId: string;

Type: string

`scope`^Required

public readonly scope: ConfigConfigRuleScopeOutputReference;

Type: ConfigConfigRuleScopeOutputReference

`source`^Required

public readonly source: ConfigConfigRuleSourceOutputReference;

Type: ConfigConfigRuleSourceOutputReference

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`inputParametersInput`^Optional

public readonly inputParametersInput: string;

Type: string

`maximumExecutionFrequencyInput`^Optional

public readonly maximumExecutionFrequencyInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`scopeInput`^Optional

public readonly scopeInput: ConfigConfigRuleScope;

Type: ConfigConfigRuleScope

`sourceInput`^Optional

public readonly sourceInput: ConfigConfigRuleSource;

Type: ConfigConfigRuleSource

`tagsAllInput`^Optional

public readonly tagsAllInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsInput`^Optional

public readonly tagsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`description`^Required

public readonly description: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`inputParameters`^Required

public readonly inputParameters: string;

Type: string

`maximumExecutionFrequency`^Required

public readonly maximumExecutionFrequency: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`tags`^Required

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

`tagsAll`^Required

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ConfigConfigRuleConfig

Initializer

import { configConfigRule } from '@cdktf/aws-cdk'

const configConfigRuleConfig: configConfigRule.ConfigConfigRuleConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#name ConfigConfigRule#name}.
`source`	`ConfigConfigRuleSource`	source block.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#description ConfigConfigRule#description}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#id ConfigConfigRule#id}.
`inputParameters`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#input_parameters ConfigConfigRule#input_parameters}.
`maximumExecutionFrequency`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#maximum_execution_frequency ConfigConfigRule#maximum_execution_frequency}.
`scope`	`ConfigConfigRuleScope`	scope block.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tags ConfigConfigRule#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tags_all ConfigConfigRule#tags_all}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#name ConfigConfigRule#name}.

`source`^Required

public readonly source: ConfigConfigRuleSource;

Type: ConfigConfigRuleSource

source block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#source ConfigConfigRule#source}

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#description ConfigConfigRule#description}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#id ConfigConfigRule#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`inputParameters`^Optional

public readonly inputParameters: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#input_parameters ConfigConfigRule#input_parameters}.

`maximumExecutionFrequency`^Optional

public readonly maximumExecutionFrequency: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#maximum_execution_frequency ConfigConfigRule#maximum_execution_frequency}.

`scope`^Optional

public readonly scope: ConfigConfigRuleScope;

Type: ConfigConfigRuleScope

scope block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#scope ConfigConfigRule#scope}

`tags`^Optional

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tags ConfigConfigRule#tags}.

`tagsAll`^Optional

public readonly tagsAll: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tags_all ConfigConfigRule#tags_all}.

ConfigConfigRuleScope

Initializer

import { configConfigRule } from '@cdktf/aws-cdk'

const configConfigRuleScope: configConfigRule.ConfigConfigRuleScope = { ... }

Properties

Name	Type	Description
`complianceResourceId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#compliance_resource_id ConfigConfigRule#compliance_resource_id}.
`complianceResourceTypes`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#compliance_resource_types ConfigConfigRule#compliance_resource_types}.
`tagKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tag_key ConfigConfigRule#tag_key}.
`tagValue`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tag_value ConfigConfigRule#tag_value}.

`complianceResourceId`^Optional

public readonly complianceResourceId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#compliance_resource_id ConfigConfigRule#compliance_resource_id}.

`complianceResourceTypes`^Optional

public readonly complianceResourceTypes: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#compliance_resource_types ConfigConfigRule#compliance_resource_types}.

`tagKey`^Optional

public readonly tagKey: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tag_key ConfigConfigRule#tag_key}.

`tagValue`^Optional

public readonly tagValue: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#tag_value ConfigConfigRule#tag_value}.

ConfigConfigRuleSource

Initializer

import { configConfigRule } from '@cdktf/aws-cdk'

const configConfigRuleSource: configConfigRule.ConfigConfigRuleSource = { ... }

Properties

Name	Type	Description
`owner`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#owner ConfigConfigRule#owner}.
`sourceIdentifier`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#source_identifier ConfigConfigRule#source_identifier}.
`sourceDetail`	`cdktf.IResolvable \| ConfigConfigRuleSourceSourceDetail[]`	source_detail block.

`owner`^Required

public readonly owner: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#owner ConfigConfigRule#owner}.

`sourceIdentifier`^Required

public readonly sourceIdentifier: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#source_identifier ConfigConfigRule#source_identifier}.

`sourceDetail`^Optional

public readonly sourceDetail: IResolvable | ConfigConfigRuleSourceSourceDetail[];

Type: cdktf.IResolvable | ConfigConfigRuleSourceSourceDetail[]

source_detail block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#source_detail ConfigConfigRule#source_detail}

ConfigConfigRuleSourceSourceDetail

Initializer

import { configConfigRule } from '@cdktf/aws-cdk'

const configConfigRuleSourceSourceDetail: configConfigRule.ConfigConfigRuleSourceSourceDetail = { ... }

Properties

Name	Type	Description
`eventSource`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#event_source ConfigConfigRule#event_source}.
`maximumExecutionFrequency`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#maximum_execution_frequency ConfigConfigRule#maximum_execution_frequency}.
`messageType`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#message_type ConfigConfigRule#message_type}.

`eventSource`^Optional

public readonly eventSource: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#event_source ConfigConfigRule#event_source}.

`maximumExecutionFrequency`^Optional

public readonly maximumExecutionFrequency: string;

Type: string

`messageType`^Optional

public readonly messageType: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_config_rule#message_type ConfigConfigRule#message_type}.

Classes

ConfigConfigRuleScopeOutputReference

Initializers

import { configConfigRule } from '@cdktf/aws-cdk'

new configConfigRule.ConfigConfigRuleScopeOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetComplianceResourceId`	No description.
`resetComplianceResourceTypes`	No description.
`resetTagKey`	No description.
`resetTagValue`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetComplianceResourceId`

public resetComplianceResourceId(): void

`resetComplianceResourceTypes`

public resetComplianceResourceTypes(): void

`resetTagKey`

public resetTagKey(): void

`resetTagValue`

public resetTagValue(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`complianceResourceIdInput`	`string`	No description.
`complianceResourceTypesInput`	`string[]`	No description.
`tagKeyInput`	`string`	No description.
`tagValueInput`	`string`	No description.
`complianceResourceId`	`string`	No description.
`complianceResourceTypes`	`string[]`	No description.
`tagKey`	`string`	No description.
`tagValue`	`string`	No description.
`internalValue`	`ConfigConfigRuleScope`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`complianceResourceIdInput`^Optional

public readonly complianceResourceIdInput: string;

Type: string

`complianceResourceTypesInput`^Optional

public readonly complianceResourceTypesInput: string[];

Type: string[]

`tagKeyInput`^Optional

public readonly tagKeyInput: string;

Type: string

`tagValueInput`^Optional

public readonly tagValueInput: string;

Type: string

`complianceResourceId`^Required

public readonly complianceResourceId: string;

Type: string

`complianceResourceTypes`^Required

public readonly complianceResourceTypes: string[];

Type: string[]

`tagKey`^Required

public readonly tagKey: string;

Type: string

`tagValue`^Required

public readonly tagValue: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ConfigConfigRuleScope;

Type: ConfigConfigRuleScope

ConfigConfigRuleSourceOutputReference

Initializers

import { configConfigRule } from '@cdktf/aws-cdk'

new configConfigRule.ConfigConfigRuleSourceOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`putSourceDetail`	No description.
`resetSourceDetail`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putSourceDetail`

public putSourceDetail(value: IResolvable | ConfigConfigRuleSourceSourceDetail[]): void

`value`^Required

Type: cdktf.IResolvable | ConfigConfigRuleSourceSourceDetail[]

`resetSourceDetail`

public resetSourceDetail(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`sourceDetail`	`ConfigConfigRuleSourceSourceDetailList`	No description.
`ownerInput`	`string`	No description.
`sourceDetailInput`	`cdktf.IResolvable \| ConfigConfigRuleSourceSourceDetail[]`	No description.
`sourceIdentifierInput`	`string`	No description.
`owner`	`string`	No description.
`sourceIdentifier`	`string`	No description.
`internalValue`	`ConfigConfigRuleSource`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`sourceDetail`^Required

public readonly sourceDetail: ConfigConfigRuleSourceSourceDetailList;

Type: ConfigConfigRuleSourceSourceDetailList

`ownerInput`^Optional

public readonly ownerInput: string;

Type: string

`sourceDetailInput`^Optional

public readonly sourceDetailInput: IResolvable | ConfigConfigRuleSourceSourceDetail[];

Type: cdktf.IResolvable | ConfigConfigRuleSourceSourceDetail[]

`sourceIdentifierInput`^Optional

public readonly sourceIdentifierInput: string;

Type: string

`owner`^Required

public readonly owner: string;

Type: string

`sourceIdentifier`^Required

public readonly sourceIdentifier: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ConfigConfigRuleSource;

Type: ConfigConfigRuleSource

ConfigConfigRuleSourceSourceDetailList

Initializers

import { configConfigRule } from '@cdktf/aws-cdk'

new configConfigRule.ConfigConfigRuleSourceSourceDetailList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): ConfigConfigRuleSourceSourceDetailOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| ConfigConfigRuleSourceSourceDetail[]`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | ConfigConfigRuleSourceSourceDetail[];

Type: cdktf.IResolvable | ConfigConfigRuleSourceSourceDetail[]

ConfigConfigRuleSourceSourceDetailOutputReference

Initializers

import { configConfigRule } from '@cdktf/aws-cdk'

new configConfigRule.ConfigConfigRuleSourceSourceDetailOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`computeFqn`	No description.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`interpolationForAttribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`resetEventSource`	No description.
`resetMaximumExecutionFrequency`	No description.
`resetMessageType`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetEventSource`

public resetEventSource(): void

`resetMaximumExecutionFrequency`

public resetMaximumExecutionFrequency(): void

`resetMessageType`

public resetMessageType(): void

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`eventSourceInput`	`string`	No description.
`maximumExecutionFrequencyInput`	`string`	No description.
`messageTypeInput`	`string`	No description.
`eventSource`	`string`	No description.
`maximumExecutionFrequency`	`string`	No description.
`messageType`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| ConfigConfigRuleSourceSourceDetail`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`eventSourceInput`^Optional

public readonly eventSourceInput: string;

Type: string

`maximumExecutionFrequencyInput`^Optional

public readonly maximumExecutionFrequencyInput: string;

Type: string

`messageTypeInput`^Optional

public readonly messageTypeInput: string;

Type: string

`eventSource`^Required

public readonly eventSource: string;

Type: string

`maximumExecutionFrequency`^Required

public readonly maximumExecutionFrequency: string;

Type: string

`messageType`^Required

public readonly messageType: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | ConfigConfigRuleSourceSourceDetail;

Type: cdktf.IResolvable | ConfigConfigRuleSourceSourceDetail

Uh oh!

FilesExpand file tree

configConfigRule.md

Latest commit

History

configConfigRule.md

File metadata and controls

configConfigRule Submodule

Constructs