Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule aws_config_organization_custom_rule}.
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
new configOrganizationCustomRule.ConfigOrganizationCustomRule(scope: Construct, id: string, config: ConfigOrganizationCustomRuleConfig)| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
ConfigOrganizationCustomRuleConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
| 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". |
putTimeouts |
No description. |
resetDescription |
No description. |
resetExcludedAccounts |
No description. |
resetId |
No description. |
resetInputParameters |
No description. |
resetMaximumExecutionFrequency |
No description. |
resetResourceIdScope |
No description. |
resetResourceTypesScope |
No description. |
resetTagKeyScope |
No description. |
resetTagValueScope |
No description. |
resetTimeouts |
No description. |
public toString(): stringReturns a string representation of this construct.
public addOverride(path: string, value: any): void- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): voidOverrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): voidResets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): anypublic toMetadata(): anypublic toTerraform(): anyAdds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): voidAdds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}- Type: string
public getListAttribute(terraformAttribute: string): string[]- Type: string
public getNumberAttribute(terraformAttribute: string): number- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}- Type: string
public getStringAttribute(terraformAttribute: string): string- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveByIdpublic importFrom(id: string, provider?: TerraformProvider): void- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable- Type: string
public moveFromId(id: string): voidMove 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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): voidMoves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): voidMoves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putTimeouts(value: ConfigOrganizationCustomRuleTimeouts): voidpublic resetDescription(): voidpublic resetExcludedAccounts(): voidpublic resetId(): voidpublic resetInputParameters(): voidpublic resetMaximumExecutionFrequency(): voidpublic resetResourceIdScope(): voidpublic resetResourceTypesScope(): voidpublic resetTagKeyScope(): voidpublic resetTagValueScope(): voidpublic resetTimeouts(): void| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a ConfigOrganizationCustomRule resource upon running "cdktf plan ". |
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
configOrganizationCustomRule.ConfigOrganizationCustomRule.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.
- Type: any
Any object.
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
configOrganizationCustomRule.ConfigOrganizationCustomRule.isTerraformElement(x: any)- Type: any
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
configOrganizationCustomRule.ConfigOrganizationCustomRule.isTerraformResource(x: any)- Type: any
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
configOrganizationCustomRule.ConfigOrganizationCustomRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)Generates CDKTF code for importing a ConfigOrganizationCustomRule resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the ConfigOrganizationCustomRule to import.
- Type: string
The id of the existing ConfigOrganizationCustomRule that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the ConfigOrganizationCustomRule to import is found.
| 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. |
timeouts |
ConfigOrganizationCustomRuleTimeoutsOutputReference |
No description. |
descriptionInput |
string |
No description. |
excludedAccountsInput |
string[] |
No description. |
idInput |
string |
No description. |
inputParametersInput |
string |
No description. |
lambdaFunctionArnInput |
string |
No description. |
maximumExecutionFrequencyInput |
string |
No description. |
nameInput |
string |
No description. |
resourceIdScopeInput |
string |
No description. |
resourceTypesScopeInput |
string[] |
No description. |
tagKeyScopeInput |
string |
No description. |
tagValueScopeInput |
string |
No description. |
timeoutsInput |
cdktf.IResolvable | ConfigOrganizationCustomRuleTimeouts |
No description. |
triggerTypesInput |
string[] |
No description. |
description |
string |
No description. |
excludedAccounts |
string[] |
No description. |
id |
string |
No description. |
inputParameters |
string |
No description. |
lambdaFunctionArn |
string |
No description. |
maximumExecutionFrequency |
string |
No description. |
name |
string |
No description. |
resourceIdScope |
string |
No description. |
resourceTypesScope |
string[] |
No description. |
tagKeyScope |
string |
No description. |
tagValueScope |
string |
No description. |
triggerTypes |
string[] |
No description. |
public readonly node: Node;- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;- Type: cdktf.TerraformStack
public readonly fqn: string;- Type: string
public readonly friendlyUniqueId: string;- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];- Type: string[]
public readonly forEach: ITerraformIterator;- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;- Type: string
public readonly timeouts: ConfigOrganizationCustomRuleTimeoutsOutputReference;public readonly descriptionInput: string;- Type: string
public readonly excludedAccountsInput: string[];- Type: string[]
public readonly idInput: string;- Type: string
public readonly inputParametersInput: string;- Type: string
public readonly lambdaFunctionArnInput: string;- Type: string
public readonly maximumExecutionFrequencyInput: string;- Type: string
public readonly nameInput: string;- Type: string
public readonly resourceIdScopeInput: string;- Type: string
public readonly resourceTypesScopeInput: string[];- Type: string[]
public readonly tagKeyScopeInput: string;- Type: string
public readonly tagValueScopeInput: string;- Type: string
public readonly timeoutsInput: IResolvable | ConfigOrganizationCustomRuleTimeouts;- Type: cdktf.IResolvable | ConfigOrganizationCustomRuleTimeouts
public readonly triggerTypesInput: string[];- Type: string[]
public readonly description: string;- Type: string
public readonly excludedAccounts: string[];- Type: string[]
public readonly id: string;- Type: string
public readonly inputParameters: string;- Type: string
public readonly lambdaFunctionArn: string;- Type: string
public readonly maximumExecutionFrequency: string;- Type: string
public readonly name: string;- Type: string
public readonly resourceIdScope: string;- Type: string
public readonly resourceTypesScope: string[];- Type: string[]
public readonly tagKeyScope: string;- Type: string
public readonly tagValueScope: string;- Type: string
public readonly triggerTypes: string[];- Type: string[]
| Name | Type | Description |
|---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;- Type: string
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
const configOrganizationCustomRuleConfig: configOrganizationCustomRule.ConfigOrganizationCustomRuleConfig = { ... }public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly lambdaFunctionArn: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#lambda_function_arn ConfigOrganizationCustomRule#lambda_function_arn}.
public readonly name: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#name ConfigOrganizationCustomRule#name}.
public readonly triggerTypes: string[];- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#trigger_types ConfigOrganizationCustomRule#trigger_types}.
public readonly description: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#description ConfigOrganizationCustomRule#description}.
public readonly excludedAccounts: string[];- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#excluded_accounts ConfigOrganizationCustomRule#excluded_accounts}.
public readonly id: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#id ConfigOrganizationCustomRule#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.
public readonly inputParameters: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#input_parameters ConfigOrganizationCustomRule#input_parameters}.
public readonly maximumExecutionFrequency: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#maximum_execution_frequency ConfigOrganizationCustomRule#maximum_execution_frequency}.
public readonly resourceIdScope: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#resource_id_scope ConfigOrganizationCustomRule#resource_id_scope}.
public readonly resourceTypesScope: string[];- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#resource_types_scope ConfigOrganizationCustomRule#resource_types_scope}.
public readonly tagKeyScope: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#tag_key_scope ConfigOrganizationCustomRule#tag_key_scope}.
public readonly tagValueScope: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#tag_value_scope ConfigOrganizationCustomRule#tag_value_scope}.
public readonly timeouts: ConfigOrganizationCustomRuleTimeouts;timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#timeouts ConfigOrganizationCustomRule#timeouts}
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
const configOrganizationCustomRuleTimeouts: configOrganizationCustomRule.ConfigOrganizationCustomRuleTimeouts = { ... }| Name | Type | Description |
|---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#create ConfigOrganizationCustomRule#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#delete ConfigOrganizationCustomRule#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#update ConfigOrganizationCustomRule#update}. |
public readonly create: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#create ConfigOrganizationCustomRule#create}.
public readonly delete: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#delete ConfigOrganizationCustomRule#delete}.
public readonly update: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/config_organization_custom_rule#update ConfigOrganizationCustomRule#update}.
import { configOrganizationCustomRule } from '@cdktf/aws-cdk'
new configOrganizationCustomRule.ConfigOrganizationCustomRuleTimeoutsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
| 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. |
resetCreate |
No description. |
resetDelete |
No description. |
resetUpdate |
No description. |
public computeFqn(): stringpublic getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}- Type: string
public getListAttribute(terraformAttribute: string): string[]- Type: string
public getNumberAttribute(terraformAttribute: string): number- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}- Type: string
public getStringAttribute(terraformAttribute: string): string- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}- Type: string
public interpolationForAttribute(property: string): IResolvable- Type: string
public resolve(_context: IResolveContext): anyProduce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): stringReturn a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): voidpublic resetDelete(): voidpublic resetUpdate(): void| Name | Type | Description |
|---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
createInput |
string |
No description. |
deleteInput |
string |
No description. |
updateInput |
string |
No description. |
create |
string |
No description. |
delete |
string |
No description. |
update |
string |
No description. |
internalValue |
cdktf.IResolvable | ConfigOrganizationCustomRuleTimeouts |
No description. |
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.
public readonly fqn: string;- Type: string
public readonly createInput: string;- Type: string
public readonly deleteInput: string;- Type: string
public readonly updateInput: string;- Type: string
public readonly create: string;- Type: string
public readonly delete: string;- Type: string
public readonly update: string;- Type: string
public readonly internalValue: IResolvable | ConfigOrganizationCustomRuleTimeouts;- Type: cdktf.IResolvable | ConfigOrganizationCustomRuleTimeouts