Skip to content

Latest commit

 

History

History
1896 lines (1184 loc) · 76.2 KB

flowLog.typescript.md

File metadata and controls

1896 lines (1184 loc) · 76.2 KB
Raw

flowLog Submodule

Constructs

FlowLog

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log aws_flow_log}.

Initializers 

import { flowLog } from '@cdktf/provider-aws'

new flowLog.FlowLog(scope: Construct, id: string, config?: FlowLogConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config FlowLogConfig 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.
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".
putDestinationOptions No description.
resetDeliverCrossAccountRole No description.
resetDestinationOptions No description.
resetEniId No description.
resetIamRoleArn No description.
resetId No description.
resetLogDestination No description.
resetLogDestinationType No description.
resetLogFormat No description.
resetLogGroupName No description.
resetMaxAggregationInterval No description.
resetSubnetId No description.
resetTags No description.
resetTagsAll No description.
resetTrafficType No description.
resetTransitGatewayAttachmentId No description.
resetTransitGatewayId No description.
resetVpcId No description.
toString 
public toString(): string

Returns a string representation of this construct.

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

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

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

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

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

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

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

moveToId 
public moveToId(id: string): void

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

idRequired
  • Type: string

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

putDestinationOptions 
public putDestinationOptions(value: FlowLogDestinationOptions): void
valueRequired
resetDeliverCrossAccountRole 
public resetDeliverCrossAccountRole(): void
resetDestinationOptions 
public resetDestinationOptions(): void
resetEniId 
public resetEniId(): void
resetIamRoleArn 
public resetIamRoleArn(): void
resetId 
public resetId(): void
resetLogDestination 
public resetLogDestination(): void
resetLogDestinationType 
public resetLogDestinationType(): void
resetLogFormat 
public resetLogFormat(): void
resetLogGroupName 
public resetLogGroupName(): void
resetMaxAggregationInterval 
public resetMaxAggregationInterval(): void
resetSubnetId 
public resetSubnetId(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTrafficType 
public resetTrafficType(): void
resetTransitGatewayAttachmentId 
public resetTransitGatewayAttachmentId(): void
resetTransitGatewayId 
public resetTransitGatewayId(): void
resetVpcId 
public resetVpcId(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a FlowLog resource upon running "cdktf plan ".
isConstruct 
import { flowLog } from '@cdktf/provider-aws'

flowLog.FlowLog.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 { flowLog } from '@cdktf/provider-aws'

flowLog.FlowLog.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { flowLog } from '@cdktf/provider-aws'

flowLog.FlowLog.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { flowLog } from '@cdktf/provider-aws'

flowLog.FlowLog.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing FlowLog that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#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 FlowLog to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
destinationOptions FlowLogDestinationOptionsOutputReference No description.
deliverCrossAccountRoleInput string No description.
destinationOptionsInput FlowLogDestinationOptions No description.
eniIdInput string No description.
iamRoleArnInput string No description.
idInput string No description.
logDestinationInput string No description.
logDestinationTypeInput string No description.
logFormatInput string No description.
logGroupNameInput string No description.
maxAggregationIntervalInput number No description.
subnetIdInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
trafficTypeInput string No description.
transitGatewayAttachmentIdInput string No description.
transitGatewayIdInput string No description.
vpcIdInput string No description.
deliverCrossAccountRole string No description.
eniId string No description.
iamRoleArn string No description.
id string No description.
logDestination string No description.
logDestinationType string No description.
logFormat string No description.
logGroupName string No description.
maxAggregationInterval number No description.
subnetId string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
trafficType string No description.
transitGatewayAttachmentId string No description.
transitGatewayId string No description.
vpcId 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[]
arnRequired 
public readonly arn: string;
  • Type: string
destinationOptionsRequired 
public readonly destinationOptions: FlowLogDestinationOptionsOutputReference;
deliverCrossAccountRoleInputOptional 
public readonly deliverCrossAccountRoleInput: string;
  • Type: string
destinationOptionsInputOptional 
public readonly destinationOptionsInput: FlowLogDestinationOptions;
eniIdInputOptional 
public readonly eniIdInput: string;
  • Type: string
iamRoleArnInputOptional 
public readonly iamRoleArnInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
logDestinationInputOptional 
public readonly logDestinationInput: string;
  • Type: string
logDestinationTypeInputOptional 
public readonly logDestinationTypeInput: string;
  • Type: string
logFormatInputOptional 
public readonly logFormatInput: string;
  • Type: string
logGroupNameInputOptional 
public readonly logGroupNameInput: string;
  • Type: string
maxAggregationIntervalInputOptional 
public readonly maxAggregationIntervalInput: number;
  • Type: number
subnetIdInputOptional 
public readonly subnetIdInput: 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}
trafficTypeInputOptional 
public readonly trafficTypeInput: string;
  • Type: string
transitGatewayAttachmentIdInputOptional 
public readonly transitGatewayAttachmentIdInput: string;
  • Type: string
transitGatewayIdInputOptional 
public readonly transitGatewayIdInput: string;
  • Type: string
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
deliverCrossAccountRoleRequired 
public readonly deliverCrossAccountRole: string;
  • Type: string
eniIdRequired 
public readonly eniId: string;
  • Type: string
iamRoleArnRequired 
public readonly iamRoleArn: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
logDestinationRequired 
public readonly logDestination: string;
  • Type: string
logDestinationTypeRequired 
public readonly logDestinationType: string;
  • Type: string
logFormatRequired 
public readonly logFormat: string;
  • Type: string
logGroupNameRequired 
public readonly logGroupName: string;
  • Type: string
maxAggregationIntervalRequired 
public readonly maxAggregationInterval: number;
  • Type: number
subnetIdRequired 
public readonly subnetId: 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}
trafficTypeRequired 
public readonly trafficType: string;
  • Type: string
transitGatewayAttachmentIdRequired 
public readonly transitGatewayAttachmentId: string;
  • Type: string
transitGatewayIdRequired 
public readonly transitGatewayId: string;
  • Type: string
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Constants

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

Structs

FlowLogConfig

Initializer 

import { flowLog } from '@cdktf/provider-aws'

const flowLogConfig: flowLog.FlowLogConfig = { ... }

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.
deliverCrossAccountRole string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#deliver_cross_account_role FlowLog#deliver_cross_account_role}.
destinationOptions FlowLogDestinationOptions destination_options block.
eniId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#eni_id FlowLog#eni_id}.
iamRoleArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#iam_role_arn FlowLog#iam_role_arn}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#id FlowLog#id}.
logDestination string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_destination FlowLog#log_destination}.
logDestinationType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_destination_type FlowLog#log_destination_type}.
logFormat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_format FlowLog#log_format}.
logGroupName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_group_name FlowLog#log_group_name}.
maxAggregationInterval number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#max_aggregation_interval FlowLog#max_aggregation_interval}.
subnetId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#subnet_id FlowLog#subnet_id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#tags FlowLog#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#tags_all FlowLog#tags_all}.
trafficType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#traffic_type FlowLog#traffic_type}.
transitGatewayAttachmentId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#transit_gateway_attachment_id FlowLog#transit_gateway_attachment_id}.
transitGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#transit_gateway_id FlowLog#transit_gateway_id}.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#vpc_id FlowLog#vpc_id}.
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[]
deliverCrossAccountRoleOptional 
public readonly deliverCrossAccountRole: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#deliver_cross_account_role FlowLog#deliver_cross_account_role}.

destinationOptionsOptional 
public readonly destinationOptions: FlowLogDestinationOptions;

destination_options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#destination_options FlowLog#destination_options}

eniIdOptional 
public readonly eniId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#eni_id FlowLog#eni_id}.

iamRoleArnOptional 
public readonly iamRoleArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#iam_role_arn FlowLog#iam_role_arn}.

idOptional 
public readonly id: string;
  • Type: string

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

logDestinationOptional 
public readonly logDestination: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_destination FlowLog#log_destination}.

logDestinationTypeOptional 
public readonly logDestinationType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_destination_type FlowLog#log_destination_type}.

logFormatOptional 
public readonly logFormat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_format FlowLog#log_format}.

logGroupNameOptional 
public readonly logGroupName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#log_group_name FlowLog#log_group_name}.

maxAggregationIntervalOptional 
public readonly maxAggregationInterval: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#max_aggregation_interval FlowLog#max_aggregation_interval}.

subnetIdOptional 
public readonly subnetId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#subnet_id FlowLog#subnet_id}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#tags FlowLog#tags}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#tags_all FlowLog#tags_all}.

trafficTypeOptional 
public readonly trafficType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#traffic_type FlowLog#traffic_type}.

transitGatewayAttachmentIdOptional 
public readonly transitGatewayAttachmentId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#transit_gateway_attachment_id FlowLog#transit_gateway_attachment_id}.

transitGatewayIdOptional 
public readonly transitGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#transit_gateway_id FlowLog#transit_gateway_id}.

vpcIdOptional 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#vpc_id FlowLog#vpc_id}.

FlowLogDestinationOptions

Initializer 

import { flowLog } from '@cdktf/provider-aws'

const flowLogDestinationOptions: flowLog.FlowLogDestinationOptions = { ... }

Properties

Name Type Description
fileFormat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#file_format FlowLog#file_format}.
hiveCompatiblePartitions boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#hive_compatible_partitions FlowLog#hive_compatible_partitions}.
perHourPartition boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#per_hour_partition FlowLog#per_hour_partition}.
fileFormatOptional 
public readonly fileFormat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#file_format FlowLog#file_format}.

hiveCompatiblePartitionsOptional 
public readonly hiveCompatiblePartitions: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#hive_compatible_partitions FlowLog#hive_compatible_partitions}.

perHourPartitionOptional 
public readonly perHourPartition: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.72.1/docs/resources/flow_log#per_hour_partition FlowLog#per_hour_partition}.

Classes

FlowLogDestinationOptionsOutputReference

Initializers 

import { flowLog } from '@cdktf/provider-aws'

new flowLog.FlowLogDestinationOptionsOutputReference(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.
resetFileFormat No description.
resetHiveCompatiblePartitions No description.
resetPerHourPartition 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.

resetFileFormat 
public resetFileFormat(): void
resetHiveCompatiblePartitions 
public resetHiveCompatiblePartitions(): void
resetPerHourPartition 
public resetPerHourPartition(): 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.
fileFormatInput string No description.
hiveCompatiblePartitionsInput boolean | cdktf.IResolvable No description.
perHourPartitionInput boolean | cdktf.IResolvable No description.
fileFormat string No description.
hiveCompatiblePartitions boolean | cdktf.IResolvable No description.
perHourPartition boolean | cdktf.IResolvable No description.
internalValue FlowLogDestinationOptions 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
fileFormatInputOptional 
public readonly fileFormatInput: string;
  • Type: string
hiveCompatiblePartitionsInputOptional 
public readonly hiveCompatiblePartitionsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
perHourPartitionInputOptional 
public readonly perHourPartitionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
fileFormatRequired 
public readonly fileFormat: string;
  • Type: string
hiveCompatiblePartitionsRequired 
public readonly hiveCompatiblePartitions: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
perHourPartitionRequired 
public readonly perHourPartition: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: FlowLogDestinationOptions;