flow_log.md

permalink
/flow_log/

flow_log

flow_log represents the aws_flow_log Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withDeliverCrossAccountRole()
• fn withDestinationOptions()
• fn withDestinationOptionsMixin()
• fn withEniId()
• fn withIamRoleArn()
• fn withLogDestination()
• fn withLogDestinationType()
• fn withLogFormat()
• fn withLogGroupName()
• fn withMaxAggregationInterval()
• fn withSubnetId()
• fn withTags()
• fn withTagsAll()
• fn withTrafficType()
• fn withTransitGatewayAttachmentId()
• fn withTransitGatewayId()
• fn withVpcId()
• obj destination_options
  • fn new()

Fields

fn new

new()

aws.flow_log.new injects a new aws_flow_log Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.flow_log.new('some_id')

You can get the reference to the id field of the created aws.flow_log using the reference:

$._ref.aws_flow_log.some_id.get('id')

This is the same as directly entering "${ aws_flow_log.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• deliver_cross_account_role (string): Set the deliver_cross_account_role field on the resulting resource block. When null, the deliver_cross_account_role field will be omitted from the resulting object.
• eni_id (string): Set the eni_id field on the resulting resource block. When null, the eni_id field will be omitted from the resulting object.
• iam_role_arn (string): Set the iam_role_arn field on the resulting resource block. When null, the iam_role_arn field will be omitted from the resulting object.
• log_destination (string): Set the log_destination field on the resulting resource block. When null, the log_destination field will be omitted from the resulting object.
• log_destination_type (string): Set the log_destination_type field on the resulting resource block. When null, the log_destination_type field will be omitted from the resulting object.
• log_format (string): Set the log_format field on the resulting resource block. When null, the log_format field will be omitted from the resulting object.
• log_group_name (string): Set the log_group_name field on the resulting resource block. When null, the log_group_name field will be omitted from the resulting object.
• max_aggregation_interval (number): Set the max_aggregation_interval field on the resulting resource block. When null, the max_aggregation_interval field will be omitted from the resulting object.
• subnet_id (string): Set the subnet_id field on the resulting resource block. When null, the subnet_id field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• traffic_type (string): Set the traffic_type field on the resulting resource block. When null, the traffic_type field will be omitted from the resulting object.
• transit_gateway_attachment_id (string): Set the transit_gateway_attachment_id field on the resulting resource block. When null, the transit_gateway_attachment_id field will be omitted from the resulting object.
• transit_gateway_id (string): Set the transit_gateway_id field on the resulting resource block. When null, the transit_gateway_id field will be omitted from the resulting object.
• vpc_id (string): Set the vpc_id field on the resulting resource block. When null, the vpc_id field will be omitted from the resulting object.
• destination_options (list[obj]): Set the destination_options field on the resulting resource block. When null, the destination_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.flow_log.destination_options.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.flow_log.newAttrs constructs a new object with attributes and blocks configured for the flow_log Terraform resource.

Unlike aws.flow_log.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• deliver_cross_account_role (string): Set the deliver_cross_account_role field on the resulting object. When null, the deliver_cross_account_role field will be omitted from the resulting object.
• eni_id (string): Set the eni_id field on the resulting object. When null, the eni_id field will be omitted from the resulting object.
• iam_role_arn (string): Set the iam_role_arn field on the resulting object. When null, the iam_role_arn field will be omitted from the resulting object.
• log_destination (string): Set the log_destination field on the resulting object. When null, the log_destination field will be omitted from the resulting object.
• log_destination_type (string): Set the log_destination_type field on the resulting object. When null, the log_destination_type field will be omitted from the resulting object.
• log_format (string): Set the log_format field on the resulting object. When null, the log_format field will be omitted from the resulting object.
• log_group_name (string): Set the log_group_name field on the resulting object. When null, the log_group_name field will be omitted from the resulting object.
• max_aggregation_interval (number): Set the max_aggregation_interval field on the resulting object. When null, the max_aggregation_interval field will be omitted from the resulting object.
• subnet_id (string): Set the subnet_id field on the resulting object. When null, the subnet_id field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• traffic_type (string): Set the traffic_type field on the resulting object. When null, the traffic_type field will be omitted from the resulting object.
• transit_gateway_attachment_id (string): Set the transit_gateway_attachment_id field on the resulting object. When null, the transit_gateway_attachment_id field will be omitted from the resulting object.
• transit_gateway_id (string): Set the transit_gateway_id field on the resulting object. When null, the transit_gateway_id field will be omitted from the resulting object.
• vpc_id (string): Set the vpc_id field on the resulting object. When null, the vpc_id field will be omitted from the resulting object.
• destination_options (list[obj]): Set the destination_options field on the resulting object. When null, the destination_options sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.flow_log.destination_options.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new flow_log resource into the root Terraform configuration.

fn withDeliverCrossAccountRole

withDeliverCrossAccountRole()

aws.string.withDeliverCrossAccountRole constructs a mixin object that can be merged into the string Terraform resource block to set or update the deliver_cross_account_role field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the deliver_cross_account_role field.

fn withDestinationOptions

withDestinationOptions()

aws.list[obj].withDestinationOptions constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the destination_options field.

This function will replace the array with the passed in value. If you wish to instead append the passed in value to the existing array, use the aws.list[obj].withDestinationOptionsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the destination_options field.

fn withDestinationOptionsMixin

withDestinationOptionsMixin()

aws.list[obj].withDestinationOptionsMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the destination_options field.

This function will append the passed in array or object to the existing array. If you wish to instead replace the array with the passed in value, use the aws.list[obj].withDestinationOptions function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the destination_options field.

fn withEniId

withEniId()

aws.string.withEniId constructs a mixin object that can be merged into the string Terraform resource block to set or update the eni_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the eni_id field.

fn withIamRoleArn

withIamRoleArn()

aws.string.withIamRoleArn constructs a mixin object that can be merged into the string Terraform resource block to set or update the iam_role_arn field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the iam_role_arn field.

fn withLogDestination

withLogDestination()

aws.string.withLogDestination constructs a mixin object that can be merged into the string Terraform resource block to set or update the log_destination field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the log_destination field.

fn withLogDestinationType

withLogDestinationType()

aws.string.withLogDestinationType constructs a mixin object that can be merged into the string Terraform resource block to set or update the log_destination_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the log_destination_type field.

fn withLogFormat

withLogFormat()

aws.string.withLogFormat constructs a mixin object that can be merged into the string Terraform resource block to set or update the log_format field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the log_format field.

fn withLogGroupName

withLogGroupName()

aws.string.withLogGroupName constructs a mixin object that can be merged into the string Terraform resource block to set or update the log_group_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the log_group_name field.

fn withMaxAggregationInterval

withMaxAggregationInterval()

aws.number.withMaxAggregationInterval constructs a mixin object that can be merged into the number Terraform resource block to set or update the max_aggregation_interval field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the max_aggregation_interval field.

fn withSubnetId

withSubnetId()

aws.string.withSubnetId constructs a mixin object that can be merged into the string Terraform resource block to set or update the subnet_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the subnet_id field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

fn withTrafficType

withTrafficType()

aws.string.withTrafficType constructs a mixin object that can be merged into the string Terraform resource block to set or update the traffic_type field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the traffic_type field.

fn withTransitGatewayAttachmentId

withTransitGatewayAttachmentId()

aws.string.withTransitGatewayAttachmentId constructs a mixin object that can be merged into the string Terraform resource block to set or update the transit_gateway_attachment_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the transit_gateway_attachment_id field.

fn withTransitGatewayId

withTransitGatewayId()

aws.string.withTransitGatewayId constructs a mixin object that can be merged into the string Terraform resource block to set or update the transit_gateway_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the transit_gateway_id field.

fn withVpcId

withVpcId()

aws.string.withVpcId constructs a mixin object that can be merged into the string Terraform resource block to set or update the vpc_id field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the vpc_id field.

obj destination_options

fn destination_options.new

new()

aws.flow_log.destination_options.new constructs a new object with attributes and blocks configured for the destination_options Terraform sub block.

Args:

• file_format (string): Set the file_format field on the resulting object. When null, the file_format field will be omitted from the resulting object.
• hive_compatible_partitions (bool): Set the hive_compatible_partitions field on the resulting object. When null, the hive_compatible_partitions field will be omitted from the resulting object.
• per_hour_partition (bool): Set the per_hour_partition field on the resulting object. When null, the per_hour_partition field will be omitted from the resulting object.

Returns:

• An attribute object that represents the destination_options sub block.