Skip to content

Latest commit

 

History

History
2328 lines (1490 loc) · 95.1 KB

File metadata and controls

2328 lines (1490 loc) · 95.1 KB

flowLog Submodule

Constructs

FlowLog

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

Initializers

from cdktn_provider_aws import flow_log

flowLog.FlowLog(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  deliver_cross_account_role: str = None,
  destination_options: FlowLogDestinationOptions = None,
  eni_id: str = None,
  iam_role_arn: str = None,
  id: str = None,
  log_destination: str = None,
  log_destination_type: str = None,
  log_format: str = None,
  max_aggregation_interval: typing.Union[int, float] = None,
  region: str = None,
  regional_nat_gateway_id: str = None,
  subnet_id: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  traffic_type: str = None,
  transit_gateway_attachment_id: str = None,
  transit_gateway_id: str = None,
  vpc_id: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
deliver_cross_account_role str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#deliver_cross_account_role FlowLog#deliver_cross_account_role}.
destination_options FlowLogDestinationOptions destination_options block.
eni_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#eni_id FlowLog#eni_id}.
iam_role_arn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#iam_role_arn FlowLog#iam_role_arn}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#id FlowLog#id}.
log_destination str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_destination FlowLog#log_destination}.
log_destination_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_destination_type FlowLog#log_destination_type}.
log_format str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_format FlowLog#log_format}.
max_aggregation_interval typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#max_aggregation_interval FlowLog#max_aggregation_interval}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
regional_nat_gateway_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#regional_nat_gateway_id FlowLog#regional_nat_gateway_id}.
subnet_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#subnet_id FlowLog#subnet_id}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#tags FlowLog#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#tags_all FlowLog#tags_all}.
traffic_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#traffic_type FlowLog#traffic_type}.
transit_gateway_attachment_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#transit_gateway_attachment_id FlowLog#transit_gateway_attachment_id}.
transit_gateway_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#transit_gateway_id FlowLog#transit_gateway_id}.
vpc_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#vpc_id FlowLog#vpc_id}.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
  • Type: cdktn.ITerraformIterator

lifecycleOptional
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
  • Type: cdktn.TerraformProvider

provisionersOptional
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

deliver_cross_account_roleOptional
  • Type: str

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


destination_optionsOptional

destination_options block.

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


eni_idOptional
  • Type: str

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


iam_role_arnOptional
  • Type: str

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


idOptional
  • Type: str

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


log_destinationOptional
  • Type: str

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


log_destination_typeOptional
  • Type: str

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


log_formatOptional
  • Type: str

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


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

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


regionOptional
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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


regional_nat_gateway_idOptional
  • Type: str

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


subnet_idOptional
  • Type: str

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


tagsOptional
  • Type: typing.Mapping[str]

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


tags_allOptional
  • Type: typing.Mapping[str]

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


traffic_typeOptional
  • Type: str

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


transit_gateway_attachment_idOptional
  • Type: str

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


transit_gateway_idOptional
  • Type: str

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


vpc_idOptional
  • Type: str

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


Methods

Name Description
to_string Returns a string representation of this construct.
with Applies one or more mixins to this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_destination_options No description.
reset_deliver_cross_account_role No description.
reset_destination_options No description.
reset_eni_id No description.
reset_iam_role_arn No description.
reset_id No description.
reset_log_destination No description.
reset_log_destination_type No description.
reset_log_format No description.
reset_max_aggregation_interval No description.
reset_region No description.
reset_regional_nat_gateway_id No description.
reset_subnet_id No description.
reset_tags No description.
reset_tags_all No description.
reset_traffic_type No description.
reset_transit_gateway_attachment_id No description.
reset_transit_gateway_id No description.
reset_vpc_id No description.

to_string
def to_string() -> str

Returns a string representation of this construct.

with
def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: *constructs.IMixin

The mixins to apply.


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

valueRequired
  • Type: typing.Any

override_logical_id
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.


reset_override_logical_id
def reset_override_logical_id() -> None

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

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

Adds this resource to the terraform JSON output.

add_move_target
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.


get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

has_resource_move
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktn.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

move_from_id
def move_from_id(
  id: str
) -> None

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

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

idRequired
  • Type: str

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


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

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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


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

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


move_to_id
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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


put_destination_options
def put_destination_options(
  file_format: str = None,
  hive_compatible_partitions: bool | IResolvable = None,
  per_hour_partition: bool | IResolvable = None
) -> None
file_formatOptional
  • Type: str

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


hive_compatible_partitionsOptional
  • Type: bool | cdktn.IResolvable

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


per_hour_partitionOptional
  • Type: bool | cdktn.IResolvable

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


reset_deliver_cross_account_role
def reset_deliver_cross_account_role() -> None
reset_destination_options
def reset_destination_options() -> None
reset_eni_id
def reset_eni_id() -> None
reset_iam_role_arn
def reset_iam_role_arn() -> None
reset_id
def reset_id() -> None
reset_log_destination
def reset_log_destination() -> None
reset_log_destination_type
def reset_log_destination_type() -> None
reset_log_format
def reset_log_format() -> None
reset_max_aggregation_interval
def reset_max_aggregation_interval() -> None
reset_region
def reset_region() -> None
reset_regional_nat_gateway_id
def reset_regional_nat_gateway_id() -> None
reset_subnet_id
def reset_subnet_id() -> None
reset_tags
def reset_tags() -> None
reset_tags_all
def reset_tags_all() -> None
reset_traffic_type
def reset_traffic_type() -> None
reset_transit_gateway_attachment_id
def reset_transit_gateway_attachment_id() -> None
reset_transit_gateway_id
def reset_transit_gateway_id() -> None
reset_vpc_id
def reset_vpc_id() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTN code for importing a FlowLog resource upon running "cdktn plan ".

is_construct
from cdktn_provider_aws import flow_log

flowLog.FlowLog.is_construct(
  x: typing.Any
)

Checks if x is a construct.

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

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

xRequired
  • Type: typing.Any

Any object.


is_terraform_element
from cdktn_provider_aws import flow_log

flowLog.FlowLog.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktn_provider_aws import flow_log

flowLog.FlowLog.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktn_provider_aws import flow_log

flowLog.FlowLog.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a FlowLog resource upon running "cdktn plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

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


import_from_idRequired
  • Type: str

The id of the existing FlowLog that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktn.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[str] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
arn str No description.
destination_options FlowLogDestinationOptionsOutputReference No description.
deliver_cross_account_role_input str No description.
destination_options_input FlowLogDestinationOptions No description.
eni_id_input str No description.
iam_role_arn_input str No description.
id_input str No description.
log_destination_input str No description.
log_destination_type_input str No description.
log_format_input str No description.
max_aggregation_interval_input typing.Union[int, float] No description.
regional_nat_gateway_id_input str No description.
region_input str No description.
subnet_id_input str No description.
tags_all_input typing.Mapping[str] No description.
tags_input typing.Mapping[str] No description.
traffic_type_input str No description.
transit_gateway_attachment_id_input str No description.
transit_gateway_id_input str No description.
vpc_id_input str No description.
deliver_cross_account_role str No description.
eni_id str No description.
iam_role_arn str No description.
id str No description.
log_destination str No description.
log_destination_type str No description.
log_format str No description.
max_aggregation_interval typing.Union[int, float] No description.
region str No description.
regional_nat_gateway_id str No description.
subnet_id str No description.
tags typing.Mapping[str] No description.
tags_all typing.Mapping[str] No description.
traffic_type str No description.
transit_gateway_attachment_id str No description.
transit_gateway_id str No description.
vpc_id str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktn.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktn.TerraformProviderGeneratorMetadata

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

provisionersOptional
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

arnRequired
arn: str
  • Type: str

destination_optionsRequired
destination_options: FlowLogDestinationOptionsOutputReference

deliver_cross_account_role_inputOptional
deliver_cross_account_role_input: str
  • Type: str

destination_options_inputOptional
destination_options_input: FlowLogDestinationOptions

eni_id_inputOptional
eni_id_input: str
  • Type: str

iam_role_arn_inputOptional
iam_role_arn_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

log_destination_inputOptional
log_destination_input: str
  • Type: str

log_destination_type_inputOptional
log_destination_type_input: str
  • Type: str

log_format_inputOptional
log_format_input: str
  • Type: str

max_aggregation_interval_inputOptional
max_aggregation_interval_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

regional_nat_gateway_id_inputOptional
regional_nat_gateway_id_input: str
  • Type: str

region_inputOptional
region_input: str
  • Type: str

subnet_id_inputOptional
subnet_id_input: str
  • Type: str

tags_all_inputOptional
tags_all_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

tags_inputOptional
tags_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

traffic_type_inputOptional
traffic_type_input: str
  • Type: str

transit_gateway_attachment_id_inputOptional
transit_gateway_attachment_id_input: str
  • Type: str

transit_gateway_id_inputOptional
transit_gateway_id_input: str
  • Type: str

vpc_id_inputOptional
vpc_id_input: str
  • Type: str

deliver_cross_account_roleRequired
deliver_cross_account_role: str
  • Type: str

eni_idRequired
eni_id: str
  • Type: str

iam_role_arnRequired
iam_role_arn: str
  • Type: str

idRequired
id: str
  • Type: str

log_destinationRequired
log_destination: str
  • Type: str

log_destination_typeRequired
log_destination_type: str
  • Type: str

log_formatRequired
log_format: str
  • Type: str

max_aggregation_intervalRequired
max_aggregation_interval: typing.Union[int, float]
  • Type: typing.Union[int, float]

regionRequired
region: str
  • Type: str

regional_nat_gateway_idRequired
regional_nat_gateway_id: str
  • Type: str

subnet_idRequired
subnet_id: str
  • Type: str

tagsRequired
tags: typing.Mapping[str]
  • Type: typing.Mapping[str]

tags_allRequired
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

traffic_typeRequired
traffic_type: str
  • Type: str

transit_gateway_attachment_idRequired
transit_gateway_attachment_id: str
  • Type: str

transit_gateway_idRequired
transit_gateway_id: str
  • Type: str

vpc_idRequired
vpc_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

FlowLogConfig

Initializer

from cdktn_provider_aws import flow_log

flowLog.FlowLogConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  deliver_cross_account_role: str = None,
  destination_options: FlowLogDestinationOptions = None,
  eni_id: str = None,
  iam_role_arn: str = None,
  id: str = None,
  log_destination: str = None,
  log_destination_type: str = None,
  log_format: str = None,
  max_aggregation_interval: typing.Union[int, float] = None,
  region: str = None,
  regional_nat_gateway_id: str = None,
  subnet_id: str = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  traffic_type: str = None,
  transit_gateway_attachment_id: str = None,
  transit_gateway_id: str = None,
  vpc_id: str = None
)

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count typing.Union[int, float] | cdktn.TerraformCount No description.
depends_on typing.List[cdktn.ITerraformDependable] No description.
for_each cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner] No description.
deliver_cross_account_role str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#deliver_cross_account_role FlowLog#deliver_cross_account_role}.
destination_options FlowLogDestinationOptions destination_options block.
eni_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#eni_id FlowLog#eni_id}.
iam_role_arn str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#iam_role_arn FlowLog#iam_role_arn}.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#id FlowLog#id}.
log_destination str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_destination FlowLog#log_destination}.
log_destination_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_destination_type FlowLog#log_destination_type}.
log_format str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#log_format FlowLog#log_format}.
max_aggregation_interval typing.Union[int, float] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#max_aggregation_interval FlowLog#max_aggregation_interval}.
region str Region where this resource will be managed. Defaults to the Region set in the provider configuration.
regional_nat_gateway_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#regional_nat_gateway_id FlowLog#regional_nat_gateway_id}.
subnet_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#subnet_id FlowLog#subnet_id}.
tags typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#tags FlowLog#tags}.
tags_all typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#tags_all FlowLog#tags_all}.
traffic_type str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#traffic_type FlowLog#traffic_type}.
transit_gateway_attachment_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#transit_gateway_attachment_id FlowLog#transit_gateway_attachment_id}.
transit_gateway_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#transit_gateway_id FlowLog#transit_gateway_id}.
vpc_id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#vpc_id FlowLog#vpc_id}.

connectionOptional
connection: SSHProvisionerConnection | WinrmProvisionerConnection
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
count: typing.Union[int, float] | TerraformCount
  • Type: typing.Union[int, float] | cdktn.TerraformCount

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktn.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktn.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktn.TerraformProvider

provisionersOptional
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
  • Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

deliver_cross_account_roleOptional
deliver_cross_account_role: str
  • Type: str

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


destination_optionsOptional
destination_options: FlowLogDestinationOptions

destination_options block.

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


eni_idOptional
eni_id: str
  • Type: str

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


iam_role_arnOptional
iam_role_arn: str
  • Type: str

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


idOptional
id: str
  • Type: str

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


log_destinationOptional
log_destination: str
  • Type: str

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


log_destination_typeOptional
log_destination_type: str
  • Type: str

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


log_formatOptional
log_format: str
  • Type: str

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


max_aggregation_intervalOptional
max_aggregation_interval: typing.Union[int, float]
  • Type: typing.Union[int, float]

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


regionOptional
region: str
  • Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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


regional_nat_gateway_idOptional
regional_nat_gateway_id: str
  • Type: str

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


subnet_idOptional
subnet_id: str
  • Type: str

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


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

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


tags_allOptional
tags_all: typing.Mapping[str]
  • Type: typing.Mapping[str]

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


traffic_typeOptional
traffic_type: str
  • Type: str

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


transit_gateway_attachment_idOptional
transit_gateway_attachment_id: str
  • Type: str

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


transit_gateway_idOptional
transit_gateway_id: str
  • Type: str

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


vpc_idOptional
vpc_id: str
  • Type: str

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


FlowLogDestinationOptions

Initializer

from cdktn_provider_aws import flow_log

flowLog.FlowLogDestinationOptions(
  file_format: str = None,
  hive_compatible_partitions: bool | IResolvable = None,
  per_hour_partition: bool | IResolvable = None
)

Properties

Name Type Description
file_format str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#file_format FlowLog#file_format}.
hive_compatible_partitions bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#hive_compatible_partitions FlowLog#hive_compatible_partitions}.
per_hour_partition bool | cdktn.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/flow_log#per_hour_partition FlowLog#per_hour_partition}.

file_formatOptional
file_format: str
  • Type: str

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


hive_compatible_partitionsOptional
hive_compatible_partitions: bool | IResolvable
  • Type: bool | cdktn.IResolvable

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


per_hour_partitionOptional
per_hour_partition: bool | IResolvable
  • Type: bool | cdktn.IResolvable

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


Classes

FlowLogDestinationOptionsOutputReference

Initializers

from cdktn_provider_aws import flow_log

flowLog.FlowLogDestinationOptionsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktn.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktn.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_file_format No description.
reset_hive_compatible_partitions No description.
reset_per_hour_partition No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktn.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_file_format
def reset_file_format() -> None
reset_hive_compatible_partitions
def reset_hive_compatible_partitions() -> None
reset_per_hour_partition
def reset_per_hour_partition() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
file_format_input str No description.
hive_compatible_partitions_input bool | cdktn.IResolvable No description.
per_hour_partition_input bool | cdktn.IResolvable No description.
file_format str No description.
hive_compatible_partitions bool | cdktn.IResolvable No description.
per_hour_partition bool | cdktn.IResolvable No description.
internal_value FlowLogDestinationOptions No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

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

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


fqnRequired
fqn: str
  • Type: str

file_format_inputOptional
file_format_input: str
  • Type: str

hive_compatible_partitions_inputOptional
hive_compatible_partitions_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

per_hour_partition_inputOptional
per_hour_partition_input: bool | IResolvable
  • Type: bool | cdktn.IResolvable

file_formatRequired
file_format: str
  • Type: str

hive_compatible_partitionsRequired
hive_compatible_partitions: bool | IResolvable
  • Type: bool | cdktn.IResolvable

per_hour_partitionRequired
per_hour_partition: bool | IResolvable
  • Type: bool | cdktn.IResolvable

internal_valueOptional
internal_value: FlowLogDestinationOptions