Skip to content

Latest commit

 

History

History
2939 lines (1862 loc) · 116 KB

logsArchive.python.md

File metadata and controls

2939 lines (1862 loc) · 116 KB
Raw

logsArchive Submodule

Constructs

LogsArchive

Represents a {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive datadog_logs_archive}.

Initializers 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchive(
  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,
  name: str,
  query: str,
  azure_archive: LogsArchiveAzureArchive = None,
  gcs_archive: LogsArchiveGcsArchive = None,
  id: str = None,
  include_tags: typing.Union[bool, IResolvable] = None,
  rehydration_max_scan_size_in_gb: typing.Union[int, float] = None,
  rehydration_tags: typing.List[str] = None,
  s3_archive: LogsArchiveS3Archive = 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.
name str Your archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
azure_archive LogsArchiveAzureArchive azure_archive block.
gcs_archive LogsArchiveGcsArchive gcs_archive block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#id LogsArchive#id}.
include_tags typing.Union[bool, cdktf.IResolvable] To store the tags in the archive, set the value true.
rehydration_max_scan_size_in_gb typing.Union[int, float] To limit the rehydration scan size for the archive, set a value in GB.
rehydration_tags typing.List[str] An array of tags to add to rehydrated logs from an archive.
s3_archive LogsArchiveS3Archive s3_archive block.
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]]
nameRequired
  • Type: str

Your archive name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#name LogsArchive#name}

queryRequired
  • Type: str

The archive query/filter. Logs matching this query are included in the archive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#query LogsArchive#query}

azure_archiveOptional

azure_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#azure_archive LogsArchive#azure_archive}

gcs_archiveOptional

gcs_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#gcs_archive LogsArchive#gcs_archive}

idOptional
  • Type: str

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

include_tagsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

To store the tags in the archive, set the value true.

If it is set to false, the tags will be dropped when the logs are sent to the archive. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#include_tags LogsArchive#include_tags}

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

To limit the rehydration scan size for the archive, set a value in GB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#rehydration_max_scan_size_in_gb LogsArchive#rehydration_max_scan_size_in_gb}

rehydration_tagsOptional
  • Type: typing.List[str]

An array of tags to add to rehydrated logs from an archive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#rehydration_tags LogsArchive#rehydration_tags}

s3_archiveOptional

s3_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#s3_archive LogsArchive#s3_archive}

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_azure_archive No description.
put_gcs_archive No description.
put_s3_archive No description.
reset_azure_archive No description.
reset_gcs_archive No description.
reset_id No description.
reset_include_tags No description.
reset_rehydration_max_scan_size_in_gb No description.
reset_rehydration_tags No description.
reset_s3_archive 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_azure_archive 
def put_azure_archive(
  client_id: str,
  container: str,
  storage_account: str,
  tenant_id: str,
  path: str = None
) -> None
client_idRequired
  • Type: str

Your client id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#client_id LogsArchive#client_id}

containerRequired
  • Type: str

The container where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#container LogsArchive#container}

storage_accountRequired
  • Type: str

The associated storage account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#storage_account LogsArchive#storage_account}

tenant_idRequired
  • Type: str

Your tenant id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#tenant_id LogsArchive#tenant_id}

pathOptional
  • Type: str

The path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

put_gcs_archive 
def put_gcs_archive(
  bucket: str,
  client_email: str,
  path: str = None,
  project_id: str = None
) -> None
bucketRequired
  • Type: str

Name of your GCS bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#bucket LogsArchive#bucket}

client_emailRequired
  • Type: str

Your client email.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#client_email LogsArchive#client_email}

pathOptional
  • Type: str

Path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

project_idOptional
  • Type: str

Your project id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#project_id LogsArchive#project_id}

put_s3_archive 
def put_s3_archive(
  account_id: str,
  bucket: str,
  role_name: str,
  path: str = None
) -> None
account_idRequired
  • Type: str

Your AWS account id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#account_id LogsArchive#account_id}

bucketRequired
  • Type: str

Name of your s3 bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#bucket LogsArchive#bucket}

role_nameRequired
  • Type: str

Your AWS role name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#role_name LogsArchive#role_name}

pathOptional
  • Type: str

Path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

reset_azure_archive 
def reset_azure_archive() -> None
reset_gcs_archive 
def reset_gcs_archive() -> None
reset_id 
def reset_id() -> None
reset_include_tags 
def reset_include_tags() -> None
reset_rehydration_max_scan_size_in_gb 
def reset_rehydration_max_scan_size_in_gb() -> None
reset_rehydration_tags 
def reset_rehydration_tags() -> None
reset_s3_archive 
def reset_s3_archive() -> 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 LogsArchive resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchive.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 logs_archive

logsArchive.LogsArchive.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchive.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchive.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a LogsArchive 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 LogsArchive to import.

import_from_idRequired
  • Type: str

The id of the existing LogsArchive that should be imported.

Refer to the {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#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 LogsArchive 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.
azure_archive LogsArchiveAzureArchiveOutputReference No description.
gcs_archive LogsArchiveGcsArchiveOutputReference No description.
s3_archive LogsArchiveS3ArchiveOutputReference No description.
azure_archive_input LogsArchiveAzureArchive No description.
gcs_archive_input LogsArchiveGcsArchive No description.
id_input str No description.
include_tags_input typing.Union[bool, cdktf.IResolvable] No description.
name_input str No description.
query_input str No description.
rehydration_max_scan_size_in_gb_input typing.Union[int, float] No description.
rehydration_tags_input typing.List[str] No description.
s3_archive_input LogsArchiveS3Archive No description.
id str No description.
include_tags typing.Union[bool, cdktf.IResolvable] No description.
name str No description.
query str No description.
rehydration_max_scan_size_in_gb typing.Union[int, float] No description.
rehydration_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]]
azure_archiveRequired 
azure_archive: LogsArchiveAzureArchiveOutputReference
gcs_archiveRequired 
gcs_archive: LogsArchiveGcsArchiveOutputReference
s3_archiveRequired 
s3_archive: LogsArchiveS3ArchiveOutputReference
azure_archive_inputOptional 
azure_archive_input: LogsArchiveAzureArchive
gcs_archive_inputOptional 
gcs_archive_input: LogsArchiveGcsArchive
id_inputOptional 
id_input: str
  • Type: str
include_tags_inputOptional 
include_tags_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
name_inputOptional 
name_input: str
  • Type: str
query_inputOptional 
query_input: str
  • Type: str
rehydration_max_scan_size_in_gb_inputOptional 
rehydration_max_scan_size_in_gb_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
rehydration_tags_inputOptional 
rehydration_tags_input: typing.List[str]
  • Type: typing.List[str]
s3_archive_inputOptional 
s3_archive_input: LogsArchiveS3Archive
idRequired 
id: str
  • Type: str
include_tagsRequired 
include_tags: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
nameRequired 
name: str
  • Type: str
queryRequired 
query: str
  • Type: str
rehydration_max_scan_size_in_gbRequired 
rehydration_max_scan_size_in_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]
rehydration_tagsRequired 
rehydration_tags: typing.List[str]
  • Type: typing.List[str]

Constants

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

Structs

LogsArchiveAzureArchive

Initializer 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveAzureArchive(
  client_id: str,
  container: str,
  storage_account: str,
  tenant_id: str,
  path: str = None
)

Properties

Name Type Description
client_id str Your client id.
container str The container where the archive is stored.
storage_account str The associated storage account.
tenant_id str Your tenant id.
path str The path where the archive is stored.
client_idRequired 
client_id: str
  • Type: str

Your client id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#client_id LogsArchive#client_id}

containerRequired 
container: str
  • Type: str

The container where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#container LogsArchive#container}

storage_accountRequired 
storage_account: str
  • Type: str

The associated storage account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#storage_account LogsArchive#storage_account}

tenant_idRequired 
tenant_id: str
  • Type: str

Your tenant id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#tenant_id LogsArchive#tenant_id}

pathOptional 
path: str
  • Type: str

The path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

LogsArchiveConfig

Initializer 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveConfig(
  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,
  name: str,
  query: str,
  azure_archive: LogsArchiveAzureArchive = None,
  gcs_archive: LogsArchiveGcsArchive = None,
  id: str = None,
  include_tags: typing.Union[bool, IResolvable] = None,
  rehydration_max_scan_size_in_gb: typing.Union[int, float] = None,
  rehydration_tags: typing.List[str] = None,
  s3_archive: LogsArchiveS3Archive = 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.
name str Your archive name.
query str The archive query/filter. Logs matching this query are included in the archive.
azure_archive LogsArchiveAzureArchive azure_archive block.
gcs_archive LogsArchiveGcsArchive gcs_archive block.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#id LogsArchive#id}.
include_tags typing.Union[bool, cdktf.IResolvable] To store the tags in the archive, set the value true.
rehydration_max_scan_size_in_gb typing.Union[int, float] To limit the rehydration scan size for the archive, set a value in GB.
rehydration_tags typing.List[str] An array of tags to add to rehydrated logs from an archive.
s3_archive LogsArchiveS3Archive s3_archive block.
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]]
nameRequired 
name: str
  • Type: str

Your archive name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#name LogsArchive#name}

queryRequired 
query: str
  • Type: str

The archive query/filter. Logs matching this query are included in the archive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#query LogsArchive#query}

azure_archiveOptional 
azure_archive: LogsArchiveAzureArchive

azure_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#azure_archive LogsArchive#azure_archive}

gcs_archiveOptional 
gcs_archive: LogsArchiveGcsArchive

gcs_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#gcs_archive LogsArchive#gcs_archive}

idOptional 
id: str
  • Type: str

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

include_tagsOptional 
include_tags: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

To store the tags in the archive, set the value true.

If it is set to false, the tags will be dropped when the logs are sent to the archive. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#include_tags LogsArchive#include_tags}

rehydration_max_scan_size_in_gbOptional 
rehydration_max_scan_size_in_gb: typing.Union[int, float]
  • Type: typing.Union[int, float]

To limit the rehydration scan size for the archive, set a value in GB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#rehydration_max_scan_size_in_gb LogsArchive#rehydration_max_scan_size_in_gb}

rehydration_tagsOptional 
rehydration_tags: typing.List[str]
  • Type: typing.List[str]

An array of tags to add to rehydrated logs from an archive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#rehydration_tags LogsArchive#rehydration_tags}

s3_archiveOptional 
s3_archive: LogsArchiveS3Archive

s3_archive block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#s3_archive LogsArchive#s3_archive}

LogsArchiveGcsArchive

Initializer 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveGcsArchive(
  bucket: str,
  client_email: str,
  path: str = None,
  project_id: str = None
)

Properties

Name Type Description
bucket str Name of your GCS bucket.
client_email str Your client email.
path str Path where the archive is stored.
project_id str Your project id.
bucketRequired 
bucket: str
  • Type: str

Name of your GCS bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#bucket LogsArchive#bucket}

client_emailRequired 
client_email: str
  • Type: str

Your client email.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#client_email LogsArchive#client_email}

pathOptional 
path: str
  • Type: str

Path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

project_idOptional 
project_id: str
  • Type: str

Your project id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#project_id LogsArchive#project_id}

LogsArchiveS3Archive

Initializer 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveS3Archive(
  account_id: str,
  bucket: str,
  role_name: str,
  path: str = None
)

Properties

Name Type Description
account_id str Your AWS account id.
bucket str Name of your s3 bucket.
role_name str Your AWS role name.
path str Path where the archive is stored.
account_idRequired 
account_id: str
  • Type: str

Your AWS account id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#account_id LogsArchive#account_id}

bucketRequired 
bucket: str
  • Type: str

Name of your s3 bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#bucket LogsArchive#bucket}

role_nameRequired 
role_name: str
  • Type: str

Your AWS role name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#role_name LogsArchive#role_name}

pathOptional 
path: str
  • Type: str

Path where the archive is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/logs_archive#path LogsArchive#path}

Classes

LogsArchiveAzureArchiveOutputReference

Initializers 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveAzureArchiveOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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.
reset_path No description.
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.

reset_path 
def reset_path() -> None

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.
client_id_input str No description.
container_input str No description.
path_input str No description.
storage_account_input str No description.
tenant_id_input str No description.
client_id str No description.
container str No description.
path str No description.
storage_account str No description.
tenant_id str No description.
internal_value LogsArchiveAzureArchive 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
client_id_inputOptional 
client_id_input: str
  • Type: str
container_inputOptional 
container_input: str
  • Type: str
path_inputOptional 
path_input: str
  • Type: str
storage_account_inputOptional 
storage_account_input: str
  • Type: str
tenant_id_inputOptional 
tenant_id_input: str
  • Type: str
client_idRequired 
client_id: str
  • Type: str
containerRequired 
container: str
  • Type: str
pathRequired 
path: str
  • Type: str
storage_accountRequired 
storage_account: str
  • Type: str
tenant_idRequired 
tenant_id: str
  • Type: str
internal_valueOptional 
internal_value: LogsArchiveAzureArchive

LogsArchiveGcsArchiveOutputReference

Initializers 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveGcsArchiveOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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.
reset_path No description.
reset_project_id No description.
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.

reset_path 
def reset_path() -> None
reset_project_id 
def reset_project_id() -> None

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.
bucket_input str No description.
client_email_input str No description.
path_input str No description.
project_id_input str No description.
bucket str No description.
client_email str No description.
path str No description.
project_id str No description.
internal_value LogsArchiveGcsArchive 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
bucket_inputOptional 
bucket_input: str
  • Type: str
client_email_inputOptional 
client_email_input: str
  • Type: str
path_inputOptional 
path_input: str
  • Type: str
project_id_inputOptional 
project_id_input: str
  • Type: str
bucketRequired 
bucket: str
  • Type: str
client_emailRequired 
client_email: str
  • Type: str
pathRequired 
path: str
  • Type: str
project_idRequired 
project_id: str
  • Type: str
internal_valueOptional 
internal_value: LogsArchiveGcsArchive

LogsArchiveS3ArchiveOutputReference

Initializers 

from cdktf_cdktf_provider_datadog import logs_archive

logsArchive.LogsArchiveS3ArchiveOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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.
reset_path No description.
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.

reset_path 
def reset_path() -> None

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.
account_id_input str No description.
bucket_input str No description.
path_input str No description.
role_name_input str No description.
account_id str No description.
bucket str No description.
path str No description.
role_name str No description.
internal_value LogsArchiveS3Archive 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
account_id_inputOptional 
account_id_input: str
  • Type: str
bucket_inputOptional 
bucket_input: str
  • Type: str
path_inputOptional 
path_input: str
  • Type: str
role_name_inputOptional 
role_name_input: str
  • Type: str
account_idRequired 
account_id: str
  • Type: str
bucketRequired 
bucket: str
  • Type: str
pathRequired 
path: str
  • Type: str
role_nameRequired 
role_name: str
  • Type: str
internal_valueOptional 
internal_value: LogsArchiveS3Archive