Skip to content

Latest commit

 

History

History
2090 lines (1323 loc) · 91.6 KB

cloudConfigurationRule.python.md

File metadata and controls

2090 lines (1323 loc) · 91.6 KB

cloudConfigurationRule Submodule

Constructs

CloudConfigurationRule

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

Initializers 

from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRule(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  enabled: typing.Union[bool, IResolvable],
  message: str,
  name: str,
  policy: str,
  resource_type: str,
  severity: str,
  filter: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]] = None,
  group_by: typing.List[str] = None,
  id: str = None,
  notifications: typing.List[str] = None,
  related_resource_types: typing.List[str] = None,
  tags: typing.List[str] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
enabled typing.Union[bool, cdktf.IResolvable] Whether the cloud configuration rule is enabled.
message str The message associated to the rule that will be shown in findings and signals.
name str The name of the cloud configuration rule.
policy str Policy written in Rego format.
resource_type str Main resource type to be checked by the rule.
severity str Severity of the rule and associated signals. Valid values are info, low, medium, high, critical.
filter typing.Union[cdktf.IResolvable, typing.List[CloudConfigurationRuleFilter]] filter block.
group_by typing.List[str] Defaults to empty list.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.53.0/docs/resources/cloud_configuration_rule#id CloudConfigurationRule#id}.
notifications typing.List[str] This function will be deprecated soon.
related_resource_types typing.List[str] Related resource types to be checked by the rule. Defaults to empty list.
tags typing.List[str] Tags of the rule, propagated to findings and signals. Defaults to empty list.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
enabledRequired
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the cloud configuration rule is enabled.

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

messageRequired
  • Type: str

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.53.0/docs/resources/cloud_configuration_rule#message CloudConfigurationRule#message}

nameRequired
  • Type: str

The name of the cloud configuration rule.

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

policyRequired
  • Type: str

Policy written in Rego format.

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

resource_typeRequired
  • Type: str

Main resource type to be checked by the rule.

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

severityRequired
  • Type: str

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.53.0/docs/resources/cloud_configuration_rule#severity CloudConfigurationRule#severity}

filterOptional

filter block.

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

group_byOptional
  • Type: typing.List[str]

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
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.53.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
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#notifications CloudConfigurationRule#notifications}

related_resource_typesOptional
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#related_resource_types CloudConfigurationRule#related_resource_types}

tagsOptional
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#tags CloudConfigurationRule#tags}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_filter No description.
reset_filter No description.
reset_group_by No description.
reset_id No description.
reset_notifications No description.
reset_related_resource_types No description.
reset_tags No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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: str

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

put_filter 
def put_filter(
  value: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]]
) -> None
valueRequired
reset_filter 
def reset_filter() -> None
reset_group_by 
def reset_group_by() -> None
reset_id 
def reset_id() -> None
reset_notifications 
def reset_notifications() -> None
reset_related_resource_types 
def reset_related_resource_types() -> None
reset_tags 
def reset_tags() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a CloudConfigurationRule resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRule.is_construct(
  x: typing.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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRule.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRule.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRule.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing CloudConfigurationRule that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.53.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.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
filter CloudConfigurationRuleFilterList No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
filter_input typing.Union[cdktf.IResolvable, typing.List[CloudConfigurationRuleFilter]] No description.
group_by_input typing.List[str] No description.
id_input str No description.
message_input str No description.
name_input str No description.
notifications_input typing.List[str] No description.
policy_input str No description.
related_resource_types_input typing.List[str] No description.
resource_type_input str No description.
severity_input str No description.
tags_input typing.List[str] No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
group_by typing.List[str] No description.
id str No description.
message str No description.
name str No description.
notifications typing.List[str] No description.
policy str No description.
related_resource_types typing.List[str] No description.
resource_type str No description.
severity str No description.
tags typing.List[str] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
filterRequired 
filter: CloudConfigurationRuleFilterList
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
filter_inputOptional 
filter_input: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]]
group_by_inputOptional 
group_by_input: typing.List[str]
  • Type: typing.List[str]
id_inputOptional 
id_input: str
  • Type: str
message_inputOptional 
message_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
notifications_inputOptional 
notifications_input: typing.List[str]
  • Type: typing.List[str]
policy_inputOptional 
policy_input: str
  • Type: str
related_resource_types_inputOptional 
related_resource_types_input: typing.List[str]
  • Type: typing.List[str]
resource_type_inputOptional 
resource_type_input: str
  • Type: str
severity_inputOptional 
severity_input: str
  • Type: str
tags_inputOptional 
tags_input: typing.List[str]
  • Type: typing.List[str]
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
group_byRequired 
group_by: typing.List[str]
  • Type: typing.List[str]
idRequired 
id: str
  • Type: str
messageRequired 
message: str
  • Type: str
nameRequired 
name: str
  • Type: str
notificationsRequired 
notifications: typing.List[str]
  • Type: typing.List[str]
policyRequired 
policy: str
  • Type: str
related_resource_typesRequired 
related_resource_types: typing.List[str]
  • Type: typing.List[str]
resource_typeRequired 
resource_type: str
  • Type: str
severityRequired 
severity: str
  • Type: str
tagsRequired 
tags: typing.List[str]
  • Type: typing.List[str]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

CloudConfigurationRuleConfig

Initializer 

from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRuleConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  enabled: typing.Union[bool, IResolvable],
  message: str,
  name: str,
  policy: str,
  resource_type: str,
  severity: str,
  filter: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]] = None,
  group_by: typing.List[str] = None,
  id: str = None,
  notifications: typing.List[str] = None,
  related_resource_types: typing.List[str] = None,
  tags: typing.List[str] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
enabled typing.Union[bool, cdktf.IResolvable] Whether the cloud configuration rule is enabled.
message str The message associated to the rule that will be shown in findings and signals.
name str The name of the cloud configuration rule.
policy str Policy written in Rego format.
resource_type str Main resource type to be checked by the rule.
severity str Severity of the rule and associated signals. Valid values are info, low, medium, high, critical.
filter typing.Union[cdktf.IResolvable, typing.List[CloudConfigurationRuleFilter]] filter block.
group_by typing.List[str] Defaults to empty list.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.53.0/docs/resources/cloud_configuration_rule#id CloudConfigurationRule#id}.
notifications typing.List[str] This function will be deprecated soon.
related_resource_types typing.List[str] Related resource types to be checked by the rule. Defaults to empty list.
tags typing.List[str] Tags of the rule, propagated to findings and signals. Defaults to empty list.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the cloud configuration rule is enabled.

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

messageRequired 
message: str
  • Type: str

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.53.0/docs/resources/cloud_configuration_rule#message CloudConfigurationRule#message}

nameRequired 
name: str
  • Type: str

The name of the cloud configuration rule.

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

policyRequired 
policy: str
  • Type: str

Policy written in Rego format.

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

resource_typeRequired 
resource_type: str
  • Type: str

Main resource type to be checked by the rule.

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

severityRequired 
severity: str
  • Type: str

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.53.0/docs/resources/cloud_configuration_rule#severity CloudConfigurationRule#severity}

filterOptional 
filter: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]]

filter block.

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

group_byOptional 
group_by: typing.List[str]
  • Type: typing.List[str]

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 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.53.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 
notifications: typing.List[str]
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#notifications CloudConfigurationRule#notifications}

related_resource_typesOptional 
related_resource_types: typing.List[str]
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#related_resource_types CloudConfigurationRule#related_resource_types}

tagsOptional 
tags: typing.List[str]
  • Type: typing.List[str]

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.53.0/docs/resources/cloud_configuration_rule#tags CloudConfigurationRule#tags}

CloudConfigurationRuleFilter

Initializer 

from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRuleFilter(
  action: str,
  query: str
)

Properties

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

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

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

queryRequired 
query: str
  • Type: str

Query for selecting logs to apply the filtering action.

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

Classes

CloudConfigurationRuleFilterList

Initializers 

from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRuleFilterList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

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

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

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

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> CloudConfigurationRuleFilterOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CloudConfigurationRuleFilter]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[CloudConfigurationRuleFilter]]

CloudConfigurationRuleFilterOutputReference

Initializers 

from cdktf_cdktf_provider_datadog import cloud_configuration_rule

cloudConfigurationRule.CloudConfigurationRuleFilterOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

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

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
action_input str No description.
query_input str No description.
action str No description.
query str No description.
internal_value typing.Union[cdktf.IResolvable, CloudConfigurationRuleFilter] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

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 
fqn: str
  • Type: str
action_inputOptional 
action_input: str
  • Type: str
query_inputOptional 
query_input: str
  • Type: str
actionRequired 
action: str
  • Type: str
queryRequired 
query: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, CloudConfigurationRuleFilter]