Skip to content

Latest commit

 

History

History
1525 lines (944 loc) · 66.3 KB

guarddutyDetector.md

File metadata and controls

1525 lines (944 loc) · 66.3 KB

aws_guardduty_detector

Refer to the Terraform Registory for docs: aws_guardduty_detector.

guarddutyDetector Submodule

Constructs

GuarddutyDetector

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector aws_guardduty_detector}.

Initializers 

import { guarddutyDetector } from '@cdktf/aws-cdk'

new guarddutyDetector.GuarddutyDetector(scope: Construct, id: string, config?: GuarddutyDetectorConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GuarddutyDetectorConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putDatasources No description.
resetDatasources No description.
resetEnable No description.
resetFindingPublishingFrequency No description.
resetId No description.
resetTags No description.
resetTagsAll No description.
toString 
public toString(): string

Returns a string representation of this construct.

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

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putDatasources 
public putDatasources(value: GuarddutyDetectorDatasources): void
valueRequired
resetDatasources 
public resetDatasources(): void
resetEnable 
public resetEnable(): void
resetFindingPublishingFrequency 
public resetFindingPublishingFrequency(): void
resetId 
public resetId(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { guarddutyDetector } from '@cdktf/aws-cdk'

guarddutyDetector.GuarddutyDetector.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { guarddutyDetector } from '@cdktf/aws-cdk'

guarddutyDetector.GuarddutyDetector.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { guarddutyDetector } from '@cdktf/aws-cdk'

guarddutyDetector.GuarddutyDetector.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
accountId string No description.
arn string No description.
datasources GuarddutyDetectorDatasourcesOutputReference No description.
datasourcesInput GuarddutyDetectorDatasources No description.
enableInput boolean | cdktf.IResolvable No description.
findingPublishingFrequencyInput string No description.
idInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
enable boolean | cdktf.IResolvable No description.
findingPublishingFrequency string No description.
id string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
accountIdRequired 
public readonly accountId: string;
  • Type: string
arnRequired 
public readonly arn: string;
  • Type: string
datasourcesRequired 
public readonly datasources: GuarddutyDetectorDatasourcesOutputReference;
datasourcesInputOptional 
public readonly datasourcesInput: GuarddutyDetectorDatasources;
enableInputOptional 
public readonly enableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
findingPublishingFrequencyInputOptional 
public readonly findingPublishingFrequencyInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
enableRequired 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
findingPublishingFrequencyRequired 
public readonly findingPublishingFrequency: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

GuarddutyDetectorConfig

Initializer 

import { guarddutyDetector } from '@cdktf/aws-cdk'

const guarddutyDetectorConfig: guarddutyDetector.GuarddutyDetectorConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
datasources GuarddutyDetectorDatasources datasources block.
enable boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#enable GuarddutyDetector#enable}.
findingPublishingFrequency string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#finding_publishing_frequency GuarddutyDetector#finding_publishing_frequency}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#id GuarddutyDetector#id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#tags GuarddutyDetector#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#tags_all GuarddutyDetector#tags_all}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
datasourcesOptional 
public readonly datasources: GuarddutyDetectorDatasources;

datasources block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#datasources GuarddutyDetector#datasources}

enableOptional 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#enable GuarddutyDetector#enable}.

findingPublishingFrequencyOptional 
public readonly findingPublishingFrequency: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#finding_publishing_frequency GuarddutyDetector#finding_publishing_frequency}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#id GuarddutyDetector#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.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#tags GuarddutyDetector#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#tags_all GuarddutyDetector#tags_all}.

GuarddutyDetectorDatasources

Initializer 

import { guarddutyDetector } from '@cdktf/aws-cdk'

const guarddutyDetectorDatasources: guarddutyDetector.GuarddutyDetectorDatasources = { ... }

Properties

Name Type Description
s3Logs GuarddutyDetectorDatasourcesS3Logs s3_logs block.
s3LogsOptional 
public readonly s3Logs: GuarddutyDetectorDatasourcesS3Logs;

s3_logs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#s3_logs GuarddutyDetector#s3_logs}

GuarddutyDetectorDatasourcesS3Logs

Initializer 

import { guarddutyDetector } from '@cdktf/aws-cdk'

const guarddutyDetectorDatasourcesS3Logs: guarddutyDetector.GuarddutyDetectorDatasourcesS3Logs = { ... }

Properties

Name Type Description
enable boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#enable GuarddutyDetector#enable}.
enableRequired 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/guardduty_detector#enable GuarddutyDetector#enable}.

Classes

GuarddutyDetectorDatasourcesOutputReference

Initializers 

import { guarddutyDetector } from '@cdktf/aws-cdk'

new guarddutyDetector.GuarddutyDetectorDatasourcesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: 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.
putS3Logs No description.
resetS3Logs No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putS3Logs 
public putS3Logs(value: GuarddutyDetectorDatasourcesS3Logs): void
valueRequired
resetS3Logs 
public resetS3Logs(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
s3Logs GuarddutyDetectorDatasourcesS3LogsOutputReference No description.
s3LogsInput GuarddutyDetectorDatasourcesS3Logs No description.
internalValue GuarddutyDetectorDatasources No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
s3LogsRequired 
public readonly s3Logs: GuarddutyDetectorDatasourcesS3LogsOutputReference;
s3LogsInputOptional 
public readonly s3LogsInput: GuarddutyDetectorDatasourcesS3Logs;
internalValueOptional 
public readonly internalValue: GuarddutyDetectorDatasources;

GuarddutyDetectorDatasourcesS3LogsOutputReference

Initializers 

import { guarddutyDetector } from '@cdktf/aws-cdk'

new guarddutyDetector.GuarddutyDetectorDatasourcesS3LogsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: 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.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
enableInput boolean | cdktf.IResolvable No description.
enable boolean | cdktf.IResolvable No description.
internalValue GuarddutyDetectorDatasourcesS3Logs No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
enableInputOptional 
public readonly enableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableRequired 
public readonly enable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: GuarddutyDetectorDatasourcesS3Logs;