cloudtrail.md

permalink
/cloudtrail/

cloudtrail

cloudtrail represents the aws_cloudtrail Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withAdvancedEventSelector()
• fn withAdvancedEventSelectorMixin()
• fn withCloudWatchLogsGroupArn()
• fn withCloudWatchLogsRoleArn()
• fn withEnableLogFileValidation()
• fn withEnableLogging()
• fn withEventSelector()
• fn withEventSelectorMixin()
• fn withIncludeGlobalServiceEvents()
• fn withInsightSelector()
• fn withInsightSelectorMixin()
• fn withIsMultiRegionTrail()
• fn withIsOrganizationTrail()
• fn withKmsKeyId()
• fn withName()
• fn withS3BucketName()
• fn withS3KeyPrefix()
• fn withSnsTopicName()
• fn withTags()
• fn withTagsAll()
• obj advanced_event_selector
  • fn new()
  • obj advanced_event_selector.field_selector
    • fn new()
• obj event_selector
  • fn new()
  • obj event_selector.data_resource
    • fn new()
• obj insight_selector
  • fn new()

Fields

fn new

new()

aws.cloudtrail.new injects a new aws_cloudtrail 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.cloudtrail.new('some_id')

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

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

This is the same as directly entering "${ aws_cloudtrail.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.
• cloud_watch_logs_group_arn (string): Set the cloud_watch_logs_group_arn field on the resulting resource block. When null, the cloud_watch_logs_group_arn field will be omitted from the resulting object.
• cloud_watch_logs_role_arn (string): Set the cloud_watch_logs_role_arn field on the resulting resource block. When null, the cloud_watch_logs_role_arn field will be omitted from the resulting object.
• enable_log_file_validation (bool): Set the enable_log_file_validation field on the resulting resource block. When null, the enable_log_file_validation field will be omitted from the resulting object.
• enable_logging (bool): Set the enable_logging field on the resulting resource block. When null, the enable_logging field will be omitted from the resulting object.
• include_global_service_events (bool): Set the include_global_service_events field on the resulting resource block. When null, the include_global_service_events field will be omitted from the resulting object.
• is_multi_region_trail (bool): Set the is_multi_region_trail field on the resulting resource block. When null, the is_multi_region_trail field will be omitted from the resulting object.
• is_organization_trail (bool): Set the is_organization_trail field on the resulting resource block. When null, the is_organization_trail field will be omitted from the resulting object.
• kms_key_id (string): Set the kms_key_id field on the resulting resource block. When null, the kms_key_id field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• s3_bucket_name (string): Set the s3_bucket_name field on the resulting resource block.
• s3_key_prefix (string): Set the s3_key_prefix field on the resulting resource block. When null, the s3_key_prefix field will be omitted from the resulting object.
• sns_topic_name (string): Set the sns_topic_name field on the resulting resource block. When null, the sns_topic_name 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.
• advanced_event_selector (list[obj]): Set the advanced_event_selector field on the resulting resource block. When null, the advanced_event_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.advanced_event_selector.new constructor.
• event_selector (list[obj]): Set the event_selector field on the resulting resource block. When null, the event_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.event_selector.new constructor.
• insight_selector (list[obj]): Set the insight_selector field on the resulting resource block. When null, the insight_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.insight_selector.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike aws.cloudtrail.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:

• cloud_watch_logs_group_arn (string): Set the cloud_watch_logs_group_arn field on the resulting object. When null, the cloud_watch_logs_group_arn field will be omitted from the resulting object.
• cloud_watch_logs_role_arn (string): Set the cloud_watch_logs_role_arn field on the resulting object. When null, the cloud_watch_logs_role_arn field will be omitted from the resulting object.
• enable_log_file_validation (bool): Set the enable_log_file_validation field on the resulting object. When null, the enable_log_file_validation field will be omitted from the resulting object.
• enable_logging (bool): Set the enable_logging field on the resulting object. When null, the enable_logging field will be omitted from the resulting object.
• include_global_service_events (bool): Set the include_global_service_events field on the resulting object. When null, the include_global_service_events field will be omitted from the resulting object.
• is_multi_region_trail (bool): Set the is_multi_region_trail field on the resulting object. When null, the is_multi_region_trail field will be omitted from the resulting object.
• is_organization_trail (bool): Set the is_organization_trail field on the resulting object. When null, the is_organization_trail field will be omitted from the resulting object.
• kms_key_id (string): Set the kms_key_id field on the resulting object. When null, the kms_key_id field will be omitted from the resulting object.
• name (string): Set the name field on the resulting object.
• s3_bucket_name (string): Set the s3_bucket_name field on the resulting object.
• s3_key_prefix (string): Set the s3_key_prefix field on the resulting object. When null, the s3_key_prefix field will be omitted from the resulting object.
• sns_topic_name (string): Set the sns_topic_name field on the resulting object. When null, the sns_topic_name 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.
• advanced_event_selector (list[obj]): Set the advanced_event_selector field on the resulting object. When null, the advanced_event_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.advanced_event_selector.new constructor.
• event_selector (list[obj]): Set the event_selector field on the resulting object. When null, the event_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.event_selector.new constructor.
• insight_selector (list[obj]): Set the insight_selector field on the resulting object. When null, the insight_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.insight_selector.new constructor.

Returns:

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

fn withAdvancedEventSelector

withAdvancedEventSelector()

aws.list[obj].withAdvancedEventSelector constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the advanced_event_selector 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].withAdvancedEventSelectorMixin function.

Args:

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

fn withAdvancedEventSelectorMixin

withAdvancedEventSelectorMixin()

aws.list[obj].withAdvancedEventSelectorMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the advanced_event_selector 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].withAdvancedEventSelector function.

Args:

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

fn withCloudWatchLogsGroupArn

withCloudWatchLogsGroupArn()

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

Args:

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

fn withCloudWatchLogsRoleArn

withCloudWatchLogsRoleArn()

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

Args:

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

fn withEnableLogFileValidation

withEnableLogFileValidation()

aws.bool.withEnableLogFileValidation constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enable_log_file_validation field.

Args:

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

fn withEnableLogging

withEnableLogging()

aws.bool.withEnableLogging constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enable_logging field.

Args:

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

fn withEventSelector

withEventSelector()

aws.list[obj].withEventSelector constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the event_selector 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].withEventSelectorMixin function.

Args:

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

fn withEventSelectorMixin

withEventSelectorMixin()

aws.list[obj].withEventSelectorMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the event_selector 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].withEventSelector function.

Args:

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

fn withIncludeGlobalServiceEvents

withIncludeGlobalServiceEvents()

aws.bool.withIncludeGlobalServiceEvents constructs a mixin object that can be merged into the bool Terraform resource block to set or update the include_global_service_events field.

Args:

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

fn withInsightSelector

withInsightSelector()

aws.list[obj].withInsightSelector constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the insight_selector 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].withInsightSelectorMixin function.

Args:

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

fn withInsightSelectorMixin

withInsightSelectorMixin()

aws.list[obj].withInsightSelectorMixin constructs a mixin object that can be merged into the list[obj] Terraform resource block to set or update the insight_selector 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].withInsightSelector function.

Args:

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

fn withIsMultiRegionTrail

withIsMultiRegionTrail()

aws.bool.withIsMultiRegionTrail constructs a mixin object that can be merged into the bool Terraform resource block to set or update the is_multi_region_trail field.

Args:

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

fn withIsOrganizationTrail

withIsOrganizationTrail()

aws.bool.withIsOrganizationTrail constructs a mixin object that can be merged into the bool Terraform resource block to set or update the is_organization_trail field.

Args:

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

fn withKmsKeyId

withKmsKeyId()

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

Args:

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

fn withName

withName()

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

Args:

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

fn withS3BucketName

withS3BucketName()

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

Args:

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

fn withS3KeyPrefix

withS3KeyPrefix()

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

Args:

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

fn withSnsTopicName

withSnsTopicName()

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

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the sns_topic_name 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.

obj advanced_event_selector

fn advanced_event_selector.new

new()

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

Args:

• name (string): Set the name field on the resulting object. When null, the name field will be omitted from the resulting object.
• field_selector (list[obj]): Set the field_selector field on the resulting object. When null, the field_selector sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.advanced_event_selector.field_selector.new constructor.

Returns:

• An attribute object that represents the advanced_event_selector sub block.

obj advanced_event_selector.field_selector

fn advanced_event_selector.field_selector.new

new()

aws.cloudtrail.advanced_event_selector.field_selector.new constructs a new object with attributes and blocks configured for the field_selector Terraform sub block.

Args:

• ends_with (list): Set the ends_with field on the resulting object. When null, the ends_with field will be omitted from the resulting object.
• equals (list): Set the equals field on the resulting object. When null, the equals field will be omitted from the resulting object.
• field (string): Set the field field on the resulting object.
• not_ends_with (list): Set the not_ends_with field on the resulting object. When null, the not_ends_with field will be omitted from the resulting object.
• not_equals (list): Set the not_equals field on the resulting object. When null, the not_equals field will be omitted from the resulting object.
• not_starts_with (list): Set the not_starts_with field on the resulting object. When null, the not_starts_with field will be omitted from the resulting object.
• starts_with (list): Set the starts_with field on the resulting object. When null, the starts_with field will be omitted from the resulting object.

Returns:

• An attribute object that represents the field_selector sub block.

obj event_selector

fn event_selector.new

new()

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

Args:

• exclude_management_event_sources (list): Set the exclude_management_event_sources field on the resulting object. When null, the exclude_management_event_sources field will be omitted from the resulting object.
• include_management_events (bool): Set the include_management_events field on the resulting object. When null, the include_management_events field will be omitted from the resulting object.
• read_write_type (string): Set the read_write_type field on the resulting object. When null, the read_write_type field will be omitted from the resulting object.
• data_resource (list[obj]): Set the data_resource field on the resulting object. When null, the data_resource sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudtrail.event_selector.data_resource.new constructor.

Returns:

• An attribute object that represents the event_selector sub block.

obj event_selector.data_resource

fn event_selector.data_resource.new

new()

aws.cloudtrail.event_selector.data_resource.new constructs a new object with attributes and blocks configured for the data_resource Terraform sub block.

Args:

• type (string): Set the type field on the resulting object.
• values (list): Set the values field on the resulting object.

Returns:

• An attribute object that represents the data_resource sub block.

obj insight_selector

fn insight_selector.new

new()

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

Args:

• insight_type (string): Set the insight_type field on the resulting object.

Returns:

• An attribute object that represents the insight_selector sub block.