cloudwatch_event_endpoint.md

permalink
/cloudwatch_event_endpoint/

cloudwatch_event_endpoint

cloudwatch_event_endpoint represents the aws_cloudwatch_event_endpoint Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withDescription()
• fn withEventBus()
• fn withEventBusMixin()
• fn withName()
• fn withReplicationConfig()
• fn withReplicationConfigMixin()
• fn withRoleArn()
• fn withRoutingConfig()
• fn withRoutingConfigMixin()
• obj event_bus
  • fn new()
• obj replication_config
  • fn new()
• obj routing_config
  • fn new()
  • obj routing_config.failover_config
    • fn new()
    • obj routing_config.failover_config.primary
      • fn new()
    • obj routing_config.failover_config.secondary
      • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_cloudwatch_event_endpoint.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.
• description (string): Set the description field on the resulting resource block. When null, the description field will be omitted from the resulting object.
• name (string): Set the name field on the resulting resource block.
• role_arn (string): Set the role_arn field on the resulting resource block. When null, the role_arn field will be omitted from the resulting object.
• event_bus (list[obj]): Set the event_bus field on the resulting resource block. When null, the event_bus sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudwatch_event_endpoint.event_bus.new constructor.
• replication_config (list[obj]): Set the replication_config field on the resulting resource block. When null, the replication_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudwatch_event_endpoint.replication_config.new constructor.
• routing_config (list[obj]): Set the routing_config field on the resulting resource block. When null, the routing_config sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudwatch_event_endpoint.routing_config.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

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

Returns:

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

fn withDescription

withDescription()

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

Args:

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

fn withEventBus

withEventBus()

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

Args:

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

fn withEventBusMixin

withEventBusMixin()

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

Args:

• resourceLabel (string): The name label of the block to update.
• value (list[obj]): The value to set for the event_bus 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 withReplicationConfig

withReplicationConfig()

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

Args:

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

fn withReplicationConfigMixin

withReplicationConfigMixin()

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

Args:

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

fn withRoleArn

withRoleArn()

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

Args:

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

fn withRoutingConfig

withRoutingConfig()

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

Args:

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

fn withRoutingConfigMixin

withRoutingConfigMixin()

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

Args:

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

obj event_bus

fn event_bus.new

new()

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

Args:

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

Returns:

• An attribute object that represents the event_bus sub block.

obj replication_config

fn replication_config.new

new()

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

Args:

• state (string): Set the state field on the resulting object. When null, the state field will be omitted from the resulting object.

Returns:

• An attribute object that represents the replication_config sub block.

obj routing_config

fn routing_config.new

new()

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

Args:

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

Returns:

• An attribute object that represents the routing_config sub block.

obj routing_config.failover_config

fn routing_config.failover_config.new

new()

aws.cloudwatch_event_endpoint.routing_config.failover_config.new constructs a new object with attributes and blocks configured for the failover_config Terraform sub block.

Args:

• primary (list[obj]): Set the primary field on the resulting object. When null, the primary sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudwatch_event_endpoint.routing_config.failover_config.primary.new constructor.
• secondary (list[obj]): Set the secondary field on the resulting object. When null, the secondary sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.cloudwatch_event_endpoint.routing_config.failover_config.secondary.new constructor.

Returns:

• An attribute object that represents the failover_config sub block.

obj routing_config.failover_config.primary

fn routing_config.failover_config.primary.new

new()

aws.cloudwatch_event_endpoint.routing_config.failover_config.primary.new constructs a new object with attributes and blocks configured for the primary Terraform sub block.

Args:

• health_check (string): Set the health_check field on the resulting object. When null, the health_check field will be omitted from the resulting object.

Returns:

• An attribute object that represents the primary sub block.

obj routing_config.failover_config.secondary

fn routing_config.failover_config.secondary.new

new()

aws.cloudwatch_event_endpoint.routing_config.failover_config.secondary.new constructs a new object with attributes and blocks configured for the secondary Terraform sub block.

Args:

• route (string): Set the route field on the resulting object. When null, the route field will be omitted from the resulting object.

Returns:

• An attribute object that represents the secondary sub block.