Skip to content

Latest commit

 

History

History
2698 lines (1677 loc) · 117 KB

logsArchive.java.md

File metadata and controls

2698 lines (1677 loc) · 117 KB
Raw

logsArchive Submodule

Constructs

LogsArchive

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

Initializers 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchive;

LogsArchive.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
    .query(java.lang.String)
//  .azureArchive(LogsArchiveAzureArchive)
//  .gcsArchive(LogsArchiveGcsArchive)
//  .id(java.lang.String)
//  .includeTags(java.lang.Boolean)
//  .includeTags(IResolvable)
//  .rehydrationMaxScanSizeInGb(java.lang.Number)
//  .rehydrationTags(java.util.List<java.lang.String>)
//  .s3Archive(LogsArchiveS3Archive)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Your archive name.
query java.lang.String The archive query/filter. Logs matching this query are included in the archive.
azureArchive LogsArchiveAzureArchive azure_archive block.
gcsArchive LogsArchiveGcsArchive gcs_archive block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.47.0/docs/resources/logs_archive#id LogsArchive#id}.
includeTags java.lang.Boolean OR com.hashicorp.cdktf.IResolvable To store the tags in the archive, set the value true.
rehydrationMaxScanSizeInGb java.lang.Number To limit the rehydration scan size for the archive, set a value in GB.
rehydrationTags java.util.List<java.lang.String> An array of tags to add to rehydrated logs from an archive.
s3Archive LogsArchiveS3Archive s3_archive block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired
  • Type: java.lang.String

Your archive name.

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

queryRequired
  • Type: java.lang.String

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.47.0/docs/resources/logs_archive#query LogsArchive#query}

azureArchiveOptional

azure_archive block.

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

gcsArchiveOptional

gcs_archive block.

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

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.47.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.

includeTagsOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.47.0/docs/resources/logs_archive#include_tags LogsArchive#include_tags}

rehydrationMaxScanSizeInGbOptional
  • Type: java.lang.Number

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.47.0/docs/resources/logs_archive#rehydration_max_scan_size_in_gb LogsArchive#rehydration_max_scan_size_in_gb}

rehydrationTagsOptional
  • Type: java.util.List<java.lang.String>

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.47.0/docs/resources/logs_archive#rehydration_tags LogsArchive#rehydration_tags}

s3ArchiveOptional

s3_archive block.

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

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".
putAzureArchive No description.
putGcsArchive No description.
putS3Archive No description.
resetAzureArchive No description.
resetGcsArchive No description.
resetId No description.
resetIncludeTags No description.
resetRehydrationMaxScanSizeInGb No description.
resetRehydrationTags No description.
resetS3Archive No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putAzureArchive 
public void putAzureArchive(LogsArchiveAzureArchive value)
valueRequired
putGcsArchive 
public void putGcsArchive(LogsArchiveGcsArchive value)
valueRequired
putS3Archive 
public void putS3Archive(LogsArchiveS3Archive value)
valueRequired
resetAzureArchive 
public void resetAzureArchive()
resetGcsArchive 
public void resetGcsArchive()
resetId 
public void resetId()
resetIncludeTags 
public void resetIncludeTags()
resetRehydrationMaxScanSizeInGb 
public void resetRehydrationMaxScanSizeInGb()
resetRehydrationTags 
public void resetRehydrationTags()
resetS3Archive 
public void resetS3Archive()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a LogsArchive resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchive;

LogsArchive.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchive;

LogsArchive.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchive;

LogsArchive.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchive;

LogsArchive.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),LogsArchive.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing LogsArchive that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
azureArchive LogsArchiveAzureArchiveOutputReference No description.
gcsArchive LogsArchiveGcsArchiveOutputReference No description.
s3Archive LogsArchiveS3ArchiveOutputReference No description.
azureArchiveInput LogsArchiveAzureArchive No description.
gcsArchiveInput LogsArchiveGcsArchive No description.
idInput java.lang.String No description.
includeTagsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
queryInput java.lang.String No description.
rehydrationMaxScanSizeInGbInput java.lang.Number No description.
rehydrationTagsInput java.util.List<java.lang.String> No description.
s3ArchiveInput LogsArchiveS3Archive No description.
id java.lang.String No description.
includeTags java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String No description.
query java.lang.String No description.
rehydrationMaxScanSizeInGb java.lang.Number No description.
rehydrationTags java.util.List<java.lang.String> No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
azureArchiveRequired 
public LogsArchiveAzureArchiveOutputReference getAzureArchive();
gcsArchiveRequired 
public LogsArchiveGcsArchiveOutputReference getGcsArchive();
s3ArchiveRequired 
public LogsArchiveS3ArchiveOutputReference getS3Archive();
azureArchiveInputOptional 
public LogsArchiveAzureArchive getAzureArchiveInput();
gcsArchiveInputOptional 
public LogsArchiveGcsArchive getGcsArchiveInput();
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
includeTagsInputOptional 
public java.lang.Object getIncludeTagsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
queryInputOptional 
public java.lang.String getQueryInput();
  • Type: java.lang.String
rehydrationMaxScanSizeInGbInputOptional 
public java.lang.Number getRehydrationMaxScanSizeInGbInput();
  • Type: java.lang.Number
rehydrationTagsInputOptional 
public java.util.List<java.lang.String> getRehydrationTagsInput();
  • Type: java.util.List<java.lang.String>
s3ArchiveInputOptional 
public LogsArchiveS3Archive getS3ArchiveInput();
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
includeTagsRequired 
public java.lang.Object getIncludeTags();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
queryRequired 
public java.lang.String getQuery();
  • Type: java.lang.String
rehydrationMaxScanSizeInGbRequired 
public java.lang.Number getRehydrationMaxScanSizeInGb();
  • Type: java.lang.Number
rehydrationTagsRequired 
public java.util.List<java.lang.String> getRehydrationTags();
  • Type: java.util.List<java.lang.String>

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

LogsArchiveAzureArchive

Initializer 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveAzureArchive;

LogsArchiveAzureArchive.builder()
    .clientId(java.lang.String)
    .container(java.lang.String)
    .storageAccount(java.lang.String)
    .tenantId(java.lang.String)
//  .path(java.lang.String)
    .build();

Properties

Name Type Description
clientId java.lang.String Your client id.
container java.lang.String The container where the archive is stored.
storageAccount java.lang.String The associated storage account.
tenantId java.lang.String Your tenant id.
path java.lang.String The path where the archive is stored.
clientIdRequired 
public java.lang.String getClientId();
  • Type: java.lang.String

Your client id.

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

containerRequired 
public java.lang.String getContainer();
  • Type: java.lang.String

The container where the archive is stored.

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

storageAccountRequired 
public java.lang.String getStorageAccount();
  • Type: java.lang.String

The associated storage account.

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

tenantIdRequired 
public java.lang.String getTenantId();
  • Type: java.lang.String

Your tenant id.

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

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

The path where the archive is stored.

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

LogsArchiveConfig

Initializer 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveConfig;

LogsArchiveConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
    .query(java.lang.String)
//  .azureArchive(LogsArchiveAzureArchive)
//  .gcsArchive(LogsArchiveGcsArchive)
//  .id(java.lang.String)
//  .includeTags(java.lang.Boolean)
//  .includeTags(IResolvable)
//  .rehydrationMaxScanSizeInGb(java.lang.Number)
//  .rehydrationTags(java.util.List<java.lang.String>)
//  .s3Archive(LogsArchiveS3Archive)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Your archive name.
query java.lang.String The archive query/filter. Logs matching this query are included in the archive.
azureArchive LogsArchiveAzureArchive azure_archive block.
gcsArchive LogsArchiveGcsArchive gcs_archive block.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.47.0/docs/resources/logs_archive#id LogsArchive#id}.
includeTags java.lang.Boolean OR com.hashicorp.cdktf.IResolvable To store the tags in the archive, set the value true.
rehydrationMaxScanSizeInGb java.lang.Number To limit the rehydration scan size for the archive, set a value in GB.
rehydrationTags java.util.List<java.lang.String> An array of tags to add to rehydrated logs from an archive.
s3Archive LogsArchiveS3Archive s3_archive block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Your archive name.

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

queryRequired 
public java.lang.String getQuery();
  • Type: java.lang.String

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.47.0/docs/resources/logs_archive#query LogsArchive#query}

azureArchiveOptional 
public LogsArchiveAzureArchive getAzureArchive();

azure_archive block.

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

gcsArchiveOptional 
public LogsArchiveGcsArchive getGcsArchive();

gcs_archive block.

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

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.47.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.

includeTagsOptional 
public java.lang.Object getIncludeTags();
  • Type: java.lang.Boolean OR com.hashicorp.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.47.0/docs/resources/logs_archive#include_tags LogsArchive#include_tags}

rehydrationMaxScanSizeInGbOptional 
public java.lang.Number getRehydrationMaxScanSizeInGb();
  • Type: java.lang.Number

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.47.0/docs/resources/logs_archive#rehydration_max_scan_size_in_gb LogsArchive#rehydration_max_scan_size_in_gb}

rehydrationTagsOptional 
public java.util.List<java.lang.String> getRehydrationTags();
  • Type: java.util.List<java.lang.String>

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.47.0/docs/resources/logs_archive#rehydration_tags LogsArchive#rehydration_tags}

s3ArchiveOptional 
public LogsArchiveS3Archive getS3Archive();

s3_archive block.

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

LogsArchiveGcsArchive

Initializer 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveGcsArchive;

LogsArchiveGcsArchive.builder()
    .bucket(java.lang.String)
    .clientEmail(java.lang.String)
//  .path(java.lang.String)
//  .projectId(java.lang.String)
    .build();

Properties

Name Type Description
bucket java.lang.String Name of your GCS bucket.
clientEmail java.lang.String Your client email.
path java.lang.String Path where the archive is stored.
projectId java.lang.String Your project id.
bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String

Name of your GCS bucket.

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

clientEmailRequired 
public java.lang.String getClientEmail();
  • Type: java.lang.String

Your client email.

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

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

Path where the archive is stored.

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

projectIdOptional 
public java.lang.String getProjectId();
  • Type: java.lang.String

Your project id.

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

LogsArchiveS3Archive

Initializer 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveS3Archive;

LogsArchiveS3Archive.builder()
    .accountId(java.lang.String)
    .bucket(java.lang.String)
    .roleName(java.lang.String)
//  .path(java.lang.String)
    .build();

Properties

Name Type Description
accountId java.lang.String Your AWS account id.
bucket java.lang.String Name of your s3 bucket.
roleName java.lang.String Your AWS role name.
path java.lang.String Path where the archive is stored.
accountIdRequired 
public java.lang.String getAccountId();
  • Type: java.lang.String

Your AWS account id.

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

bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String

Name of your s3 bucket.

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

roleNameRequired 
public java.lang.String getRoleName();
  • Type: java.lang.String

Your AWS role name.

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

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

Path where the archive is stored.

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

Classes

LogsArchiveAzureArchiveOutputReference

Initializers 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveAzureArchiveOutputReference;

new LogsArchiveAzureArchiveOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetPath No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetPath 
public void resetPath()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
clientIdInput java.lang.String No description.
containerInput java.lang.String No description.
pathInput java.lang.String No description.
storageAccountInput java.lang.String No description.
tenantIdInput java.lang.String No description.
clientId java.lang.String No description.
container java.lang.String No description.
path java.lang.String No description.
storageAccount java.lang.String No description.
tenantId java.lang.String No description.
internalValue LogsArchiveAzureArchive No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
clientIdInputOptional 
public java.lang.String getClientIdInput();
  • Type: java.lang.String
containerInputOptional 
public java.lang.String getContainerInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
storageAccountInputOptional 
public java.lang.String getStorageAccountInput();
  • Type: java.lang.String
tenantIdInputOptional 
public java.lang.String getTenantIdInput();
  • Type: java.lang.String
clientIdRequired 
public java.lang.String getClientId();
  • Type: java.lang.String
containerRequired 
public java.lang.String getContainer();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
storageAccountRequired 
public java.lang.String getStorageAccount();
  • Type: java.lang.String
tenantIdRequired 
public java.lang.String getTenantId();
  • Type: java.lang.String
internalValueOptional 
public LogsArchiveAzureArchive getInternalValue();

LogsArchiveGcsArchiveOutputReference

Initializers 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveGcsArchiveOutputReference;

new LogsArchiveGcsArchiveOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetPath No description.
resetProjectId No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetPath 
public void resetPath()
resetProjectId 
public void resetProjectId()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
bucketInput java.lang.String No description.
clientEmailInput java.lang.String No description.
pathInput java.lang.String No description.
projectIdInput java.lang.String No description.
bucket java.lang.String No description.
clientEmail java.lang.String No description.
path java.lang.String No description.
projectId java.lang.String No description.
internalValue LogsArchiveGcsArchive No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
bucketInputOptional 
public java.lang.String getBucketInput();
  • Type: java.lang.String
clientEmailInputOptional 
public java.lang.String getClientEmailInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
projectIdInputOptional 
public java.lang.String getProjectIdInput();
  • Type: java.lang.String
bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String
clientEmailRequired 
public java.lang.String getClientEmail();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
projectIdRequired 
public java.lang.String getProjectId();
  • Type: java.lang.String
internalValueOptional 
public LogsArchiveGcsArchive getInternalValue();

LogsArchiveS3ArchiveOutputReference

Initializers 

import com.hashicorp.cdktf.providers.datadog.logs_archive.LogsArchiveS3ArchiveOutputReference;

new LogsArchiveS3ArchiveOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetPath No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetPath 
public void resetPath()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
accountIdInput java.lang.String No description.
bucketInput java.lang.String No description.
pathInput java.lang.String No description.
roleNameInput java.lang.String No description.
accountId java.lang.String No description.
bucket java.lang.String No description.
path java.lang.String No description.
roleName java.lang.String No description.
internalValue LogsArchiveS3Archive No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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 java.lang.String getFqn();
  • Type: java.lang.String
accountIdInputOptional 
public java.lang.String getAccountIdInput();
  • Type: java.lang.String
bucketInputOptional 
public java.lang.String getBucketInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
roleNameInputOptional 
public java.lang.String getRoleNameInput();
  • Type: java.lang.String
accountIdRequired 
public java.lang.String getAccountId();
  • Type: java.lang.String
bucketRequired 
public java.lang.String getBucket();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
roleNameRequired 
public java.lang.String getRoleName();
  • Type: java.lang.String
internalValueOptional 
public LogsArchiveS3Archive getInternalValue();