Skip to content

Latest commit

 

History

History
1781 lines (1093 loc) · 78.9 KB

cloudConfigurationRule.typescript.md

File metadata and controls

1781 lines (1093 loc) · 78.9 KB

cloudConfigurationRule Submodule

Constructs

CloudConfigurationRule

Represents a {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule datadog_cloud_configuration_rule}.

Initializers

import { cloudConfigurationRule } from '@cdktf/provider-datadog'

new cloudConfigurationRule.CloudConfigurationRule(scope: Construct, id: string, config: CloudConfigurationRuleConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config CloudConfigurationRuleConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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".
putFilter No description.
resetFilter No description.
resetGroupBy No description.
resetId No description.
resetNotifications No description.
resetRelatedResourceTypes No description.
resetTags No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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


indexOptional
  • 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".

idRequired
  • Type: string

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


putFilter
public putFilter(value: IResolvable | CloudConfigurationRuleFilter[]): void
valueRequired

resetFilter
public resetFilter(): void
resetGroupBy
public resetGroupBy(): void
resetId
public resetId(): void
resetNotifications
public resetNotifications(): void
resetRelatedResourceTypes
public resetRelatedResourceTypes(): void
resetTags
public resetTags(): 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 CloudConfigurationRule resource upon running "cdktf plan ".

isConstruct
import { cloudConfigurationRule } from '@cdktf/provider-datadog'

cloudConfigurationRule.CloudConfigurationRule.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { cloudConfigurationRule } from '@cdktf/provider-datadog'

cloudConfigurationRule.CloudConfigurationRule.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { cloudConfigurationRule } from '@cdktf/provider-datadog'

cloudConfigurationRule.CloudConfigurationRule.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { cloudConfigurationRule } from '@cdktf/provider-datadog'

cloudConfigurationRule.CloudConfigurationRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing CloudConfigurationRule that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the CloudConfigurationRule 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.
filter CloudConfigurationRuleFilterList No description.
enabledInput boolean | cdktf.IResolvable No description.
filterInput cdktf.IResolvable | CloudConfigurationRuleFilter[] No description.
groupByInput string[] No description.
idInput string No description.
messageInput string No description.
nameInput string No description.
notificationsInput string[] No description.
policyInput string No description.
relatedResourceTypesInput string[] No description.
resourceTypeInput string No description.
severityInput string No description.
tagsInput string[] No description.
enabled boolean | cdktf.IResolvable No description.
groupBy string[] No description.
id string No description.
message string No description.
name string No description.
notifications string[] No description.
policy string No description.
relatedResourceTypes string[] No description.
resourceType string No description.
severity string No description.
tags string[] No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

filterRequired
public readonly filter: CloudConfigurationRuleFilterList;

enabledInputOptional
public readonly enabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

filterInputOptional
public readonly filterInput: IResolvable | CloudConfigurationRuleFilter[];

groupByInputOptional
public readonly groupByInput: string[];
  • Type: string[]

idInputOptional
public readonly idInput: string;
  • Type: string

messageInputOptional
public readonly messageInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

notificationsInputOptional
public readonly notificationsInput: string[];
  • Type: string[]

policyInputOptional
public readonly policyInput: string;
  • Type: string

relatedResourceTypesInputOptional
public readonly relatedResourceTypesInput: string[];
  • Type: string[]

resourceTypeInputOptional
public readonly resourceTypeInput: string;
  • Type: string

severityInputOptional
public readonly severityInput: string;
  • Type: string

tagsInputOptional
public readonly tagsInput: string[];
  • Type: string[]

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

groupByRequired
public readonly groupBy: string[];
  • Type: string[]

idRequired
public readonly id: string;
  • Type: string

messageRequired
public readonly message: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

notificationsRequired
public readonly notifications: string[];
  • Type: string[]

policyRequired
public readonly policy: string;
  • Type: string

relatedResourceTypesRequired
public readonly relatedResourceTypes: string[];
  • Type: string[]

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

severityRequired
public readonly severity: string;
  • Type: string

tagsRequired
public readonly tags: string[];
  • Type: string[]

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

CloudConfigurationRuleConfig

Initializer

import { cloudConfigurationRule } from '@cdktf/provider-datadog'

const cloudConfigurationRuleConfig: cloudConfigurationRule.CloudConfigurationRuleConfig = { ... }

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.
enabled boolean | cdktf.IResolvable Whether the cloud configuration rule is enabled.
message string The message associated to the rule that will be shown in findings and signals.
name string The name of the cloud configuration rule.
policy string Policy written in Rego format.
resourceType string Main resource type to be checked by the rule.
severity string Severity of the rule and associated signals. Valid values are info, low, medium, high, critical.
filter cdktf.IResolvable | CloudConfigurationRuleFilter[] filter block.
groupBy string[] Defaults to empty list.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#id CloudConfigurationRule#id}.
notifications string[] This function will be deprecated soon.
relatedResourceTypes string[] Related resource types to be checked by the rule. Defaults to empty list.
tags string[] Tags of the rule, propagated to findings and signals. Defaults to empty list.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

enabledRequired
public readonly enabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether the cloud configuration rule is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#enabled CloudConfigurationRule#enabled}


messageRequired
public readonly message: string;
  • Type: string

The message associated to the rule that will be shown in findings and signals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#message CloudConfigurationRule#message}


nameRequired
public readonly name: string;
  • Type: string

The name of the cloud configuration rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#name CloudConfigurationRule#name}


policyRequired
public readonly policy: string;
  • Type: string

Policy written in Rego format.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#policy CloudConfigurationRule#policy}


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

Main resource type to be checked by the rule.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#resource_type CloudConfigurationRule#resource_type}


severityRequired
public readonly severity: string;
  • Type: string

Severity of the rule and associated signals. Valid values are info, low, medium, high, critical.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#severity CloudConfigurationRule#severity}


filterOptional
public readonly filter: IResolvable | CloudConfigurationRuleFilter[];

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#filter CloudConfigurationRule#filter}


groupByOptional
public readonly groupBy: string[];
  • Type: string[]

Defaults to empty list.

This function will be deprecated soon. Use the notification rules function instead. Fields to group by when generating signals, e.g.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#id CloudConfigurationRule#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.


notificationsOptional
public readonly notifications: string[];
  • Type: string[]

This function will be deprecated soon.

Use the notification rules function instead. Notification targets for signals. Defaults to empty list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#notifications CloudConfigurationRule#notifications}


relatedResourceTypesOptional
public readonly relatedResourceTypes: string[];
  • Type: string[]

Related resource types to be checked by the rule. Defaults to empty list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#related_resource_types CloudConfigurationRule#related_resource_types}


tagsOptional
public readonly tags: string[];
  • Type: string[]

Tags of the rule, propagated to findings and signals. Defaults to empty list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#tags CloudConfigurationRule#tags}


CloudConfigurationRuleFilter

Initializer

import { cloudConfigurationRule } from '@cdktf/provider-datadog'

const cloudConfigurationRuleFilter: cloudConfigurationRule.CloudConfigurationRuleFilter = { ... }

Properties

Name Type Description
action string The type of filtering action. Valid values are require, suppress.
query string Query for selecting logs to apply the filtering action.

actionRequired
public readonly action: string;
  • Type: string

The type of filtering action. Valid values are require, suppress.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#action CloudConfigurationRule#action}


queryRequired
public readonly query: string;
  • Type: string

Query for selecting logs to apply the filtering action.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.54.0/docs/resources/cloud_configuration_rule#query CloudConfigurationRule#query}


Classes

CloudConfigurationRuleFilterList

Initializers

import { cloudConfigurationRule } from '@cdktf/provider-datadog'

new cloudConfigurationRule.CloudConfigurationRuleFilterList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): CloudConfigurationRuleFilterOutputReference
indexRequired
  • 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 | CloudConfigurationRuleFilter[] No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | CloudConfigurationRuleFilter[];

CloudConfigurationRuleFilterOutputReference

Initializers

import { cloudConfigurationRule } from '@cdktf/provider-datadog'

new cloudConfigurationRule.CloudConfigurationRuleFilterOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
actionInput string No description.
queryInput string No description.
action string No description.
query string No description.
internalValue cdktf.IResolvable | CloudConfigurationRuleFilter No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

actionInputOptional
public readonly actionInput: string;
  • Type: string

queryInputOptional
public readonly queryInput: string;
  • Type: string

actionRequired
public readonly action: string;
  • Type: string

queryRequired
public readonly query: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | CloudConfigurationRuleFilter;