ses_event_destination.md

permalink
/ses_event_destination/

ses_event_destination

ses_event_destination represents the aws_ses_event_destination Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withCloudwatchDestination()
• fn withCloudwatchDestinationMixin()
• fn withConfigurationSetName()
• fn withEnabled()
• fn withKinesisDestination()
• fn withKinesisDestinationMixin()
• fn withMatchingTypes()
• fn withName()
• fn withSnsDestination()
• fn withSnsDestinationMixin()
• obj cloudwatch_destination
  • fn new()
• obj kinesis_destination
  • fn new()
• obj sns_destination
  • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_ses_event_destination.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.
• configuration_set_name (string): Set the configuration_set_name field on the resulting resource block.
• enabled (bool): Set the enabled field on the resulting resource block. When null, the enabled field will be omitted from the resulting object.
• matching_types (list): Set the matching_types field on the resulting resource block.
• name (string): Set the name field on the resulting resource block.
• cloudwatch_destination (list[obj]): Set the cloudwatch_destination field on the resulting resource block. When null, the cloudwatch_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.cloudwatch_destination.new constructor.
• kinesis_destination (list[obj]): Set the kinesis_destination field on the resulting resource block. When null, the kinesis_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.kinesis_destination.new constructor.
• sns_destination (list[obj]): Set the sns_destination field on the resulting resource block. When null, the sns_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.sns_destination.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• configuration_set_name (string): Set the configuration_set_name field on the resulting object.
• enabled (bool): Set the enabled field on the resulting object. When null, the enabled field will be omitted from the resulting object.
• matching_types (list): Set the matching_types field on the resulting object.
• name (string): Set the name field on the resulting object.
• cloudwatch_destination (list[obj]): Set the cloudwatch_destination field on the resulting object. When null, the cloudwatch_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.cloudwatch_destination.new constructor.
• kinesis_destination (list[obj]): Set the kinesis_destination field on the resulting object. When null, the kinesis_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.kinesis_destination.new constructor.
• sns_destination (list[obj]): Set the sns_destination field on the resulting object. When null, the sns_destination sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.ses_event_destination.sns_destination.new constructor.

Returns:

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

fn withCloudwatchDestination

withCloudwatchDestination()

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

Args:

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

fn withCloudwatchDestinationMixin

withCloudwatchDestinationMixin()

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

Args:

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

fn withConfigurationSetName

withConfigurationSetName()

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

Args:

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

fn withEnabled

withEnabled()

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

Args:

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

fn withKinesisDestination

withKinesisDestination()

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

Args:

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

fn withKinesisDestinationMixin

withKinesisDestinationMixin()

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

Args:

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

fn withMatchingTypes

withMatchingTypes()

aws.list.withMatchingTypes constructs a mixin object that can be merged into the list Terraform resource block to set or update the matching_types field.

Args:

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

withSnsDestination()

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

Args:

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

fn withSnsDestinationMixin

withSnsDestinationMixin()

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

Args:

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

obj cloudwatch_destination

fn cloudwatch_destination.new

new()

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

Args:

• default_value (string): Set the default_value field on the resulting object.
• dimension_name (string): Set the dimension_name field on the resulting object.
• value_source (string): Set the value_source field on the resulting object.

Returns:

• An attribute object that represents the cloudwatch_destination sub block.

obj kinesis_destination

fn kinesis_destination.new

new()

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

Args:

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

Returns:

• An attribute object that represents the kinesis_destination sub block.

obj sns_destination

fn sns_destination.new

new()

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

Args:

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

Returns:

• An attribute object that represents the sns_destination sub block.