appsync_datasource.md

permalink
/appsync_datasource/

appsync_datasource

appsync_datasource represents the aws_appsync_datasource Terraform resource.

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

Index

• fn new()
• fn newAttrs()
• fn withApiId()
• fn withDescription()
• fn withDynamodbConfig()
• fn withDynamodbConfigMixin()
• fn withElasticsearchConfig()
• fn withElasticsearchConfigMixin()
• fn withEventBridgeConfig()
• fn withEventBridgeConfigMixin()
• fn withHttpConfig()
• fn withHttpConfigMixin()
• fn withLambdaConfig()
• fn withLambdaConfigMixin()
• fn withName()
• fn withOpensearchserviceConfig()
• fn withOpensearchserviceConfigMixin()
• fn withRelationalDatabaseConfig()
• fn withRelationalDatabaseConfigMixin()
• fn withServiceRoleArn()
• fn withType()
• obj dynamodb_config
  • fn new()
  • obj dynamodb_config.delta_sync_config
    • fn new()
• obj elasticsearch_config
  • fn new()
• obj event_bridge_config
  • fn new()
• obj http_config
  • fn new()
  • obj http_config.authorization_config
    • fn new()
    • obj http_config.authorization_config.aws_iam_config
      • fn new()
• obj lambda_config
  • fn new()
• obj opensearchservice_config
  • fn new()
• obj relational_database_config
  • fn new()
  • obj relational_database_config.http_endpoint_config
    • fn new()

Fields

fn new

new()

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

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

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

This is the same as directly entering "${ aws_appsync_datasource.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.
• api_id (string): Set the api_id field on the resulting resource 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.
• service_role_arn (string): Set the service_role_arn field on the resulting resource block. When null, the service_role_arn field will be omitted from the resulting object.
• type (string): Set the type field on the resulting resource block.
• dynamodb_config (list[obj]): Set the dynamodb_config field on the resulting resource block. When null, the dynamodb_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.appsync_datasource.dynamodb_config.new constructor.
• elasticsearch_config (list[obj]): Set the elasticsearch_config field on the resulting resource block. When null, the elasticsearch_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.appsync_datasource.elasticsearch_config.new constructor.
• event_bridge_config (list[obj]): Set the event_bridge_config field on the resulting resource block. When null, the event_bridge_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.appsync_datasource.event_bridge_config.new constructor.
• http_config (list[obj]): Set the http_config field on the resulting resource block. When null, the http_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.appsync_datasource.http_config.new constructor.
• lambda_config (list[obj]): Set the lambda_config field on the resulting resource block. When null, the lambda_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.appsync_datasource.lambda_config.new constructor.
• opensearchservice_config (list[obj]): Set the opensearchservice_config field on the resulting resource block. When null, the opensearchservice_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.appsync_datasource.opensearchservice_config.new constructor.
• relational_database_config (list[obj]): Set the relational_database_config field on the resulting resource block. When null, the relational_database_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.appsync_datasource.relational_database_config.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

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

• api_id (string): Set the api_id field on the resulting object.
• 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.
• service_role_arn (string): Set the service_role_arn field on the resulting object. When null, the service_role_arn field will be omitted from the resulting object.
• type (string): Set the type field on the resulting object.
• dynamodb_config (list[obj]): Set the dynamodb_config field on the resulting object. When null, the dynamodb_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.appsync_datasource.dynamodb_config.new constructor.
• elasticsearch_config (list[obj]): Set the elasticsearch_config field on the resulting object. When null, the elasticsearch_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.appsync_datasource.elasticsearch_config.new constructor.
• event_bridge_config (list[obj]): Set the event_bridge_config field on the resulting object. When null, the event_bridge_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.appsync_datasource.event_bridge_config.new constructor.
• http_config (list[obj]): Set the http_config field on the resulting object. When null, the http_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.appsync_datasource.http_config.new constructor.
• lambda_config (list[obj]): Set the lambda_config field on the resulting object. When null, the lambda_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.appsync_datasource.lambda_config.new constructor.
• opensearchservice_config (list[obj]): Set the opensearchservice_config field on the resulting object. When null, the opensearchservice_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.appsync_datasource.opensearchservice_config.new constructor.
• relational_database_config (list[obj]): Set the relational_database_config field on the resulting object. When null, the relational_database_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.appsync_datasource.relational_database_config.new constructor.

Returns:

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

fn withApiId

withApiId()

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

Args:

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

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 withDynamodbConfig

withDynamodbConfig()

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

Args:

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

fn withDynamodbConfigMixin

withDynamodbConfigMixin()

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

Args:

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

fn withElasticsearchConfig

withElasticsearchConfig()

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

Args:

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

fn withElasticsearchConfigMixin

withElasticsearchConfigMixin()

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

Args:

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

fn withEventBridgeConfig

withEventBridgeConfig()

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

Args:

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

fn withEventBridgeConfigMixin

withEventBridgeConfigMixin()

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

Args:

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

fn withHttpConfig

withHttpConfig()

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

Args:

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

fn withHttpConfigMixin

withHttpConfigMixin()

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

Args:

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

fn withLambdaConfig

withLambdaConfig()

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

Args:

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

fn withLambdaConfigMixin

withLambdaConfigMixin()

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

Args:

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

withOpensearchserviceConfig()

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

Args:

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

fn withOpensearchserviceConfigMixin

withOpensearchserviceConfigMixin()

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

Args:

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

fn withRelationalDatabaseConfig

withRelationalDatabaseConfig()

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

Args:

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

fn withRelationalDatabaseConfigMixin

withRelationalDatabaseConfigMixin()

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

Args:

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

fn withServiceRoleArn

withServiceRoleArn()

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

Args:

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

fn withType

withType()

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

Args:

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

obj dynamodb_config

fn dynamodb_config.new

new()

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

Args:

• region (string): Set the region field on the resulting object. When null, the region field will be omitted from the resulting object.
• table_name (string): Set the table_name field on the resulting object.
• use_caller_credentials (bool): Set the use_caller_credentials field on the resulting object. When null, the use_caller_credentials field will be omitted from the resulting object.
• versioned (bool): Set the versioned field on the resulting object. When null, the versioned field will be omitted from the resulting object.
• delta_sync_config (list[obj]): Set the delta_sync_config field on the resulting object. When null, the delta_sync_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.appsync_datasource.dynamodb_config.delta_sync_config.new constructor.

Returns:

• An attribute object that represents the dynamodb_config sub block.

obj dynamodb_config.delta_sync_config

fn dynamodb_config.delta_sync_config.new

new()

aws.appsync_datasource.dynamodb_config.delta_sync_config.new constructs a new object with attributes and blocks configured for the delta_sync_config Terraform sub block.

Args:

• base_table_ttl (number): Set the base_table_ttl field on the resulting object. When null, the base_table_ttl field will be omitted from the resulting object.
• delta_sync_table_name (string): Set the delta_sync_table_name field on the resulting object.
• delta_sync_table_ttl (number): Set the delta_sync_table_ttl field on the resulting object. When null, the delta_sync_table_ttl field will be omitted from the resulting object.

Returns:

• An attribute object that represents the delta_sync_config sub block.

obj elasticsearch_config

fn elasticsearch_config.new

new()

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

Args:

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

Returns:

• An attribute object that represents the elasticsearch_config sub block.

obj event_bridge_config

fn event_bridge_config.new

new()

aws.appsync_datasource.event_bridge_config.new constructs a new object with attributes and blocks configured for the event_bridge_config 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_bridge_config sub block.

obj http_config

fn http_config.new

new()

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

Args:

• endpoint (string): Set the endpoint field on the resulting object.
• authorization_config (list[obj]): Set the authorization_config field on the resulting object. When null, the authorization_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.appsync_datasource.http_config.authorization_config.new constructor.

Returns:

• An attribute object that represents the http_config sub block.

obj http_config.authorization_config

fn http_config.authorization_config.new

new()

aws.appsync_datasource.http_config.authorization_config.new constructs a new object with attributes and blocks configured for the authorization_config Terraform sub block.

Args:

• authorization_type (string): Set the authorization_type field on the resulting object. When null, the authorization_type field will be omitted from the resulting object.
• aws_iam_config (list[obj]): Set the aws_iam_config field on the resulting object. When null, the aws_iam_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.appsync_datasource.http_config.authorization_config.aws_iam_config.new constructor.

Returns:

• An attribute object that represents the authorization_config sub block.

obj http_config.authorization_config.aws_iam_config

fn http_config.authorization_config.aws_iam_config.new

new()

aws.appsync_datasource.http_config.authorization_config.aws_iam_config.new constructs a new object with attributes and blocks configured for the aws_iam_config Terraform sub block.

Args:

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

Returns:

• An attribute object that represents the aws_iam_config sub block.

obj lambda_config

fn lambda_config.new

new()

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

Args:

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

Returns:

• An attribute object that represents the lambda_config sub block.

obj opensearchservice_config

fn opensearchservice_config.new

new()

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

Args:

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

Returns:

• An attribute object that represents the opensearchservice_config sub block.

obj relational_database_config

fn relational_database_config.new

new()

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

Args:

• source_type (string): Set the source_type field on the resulting object. When null, the source_type field will be omitted from the resulting object.
• http_endpoint_config (list[obj]): Set the http_endpoint_config field on the resulting object. When null, the http_endpoint_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.appsync_datasource.relational_database_config.http_endpoint_config.new constructor.

Returns:

• An attribute object that represents the relational_database_config sub block.

obj relational_database_config.http_endpoint_config

fn relational_database_config.http_endpoint_config.new

new()

aws.appsync_datasource.relational_database_config.http_endpoint_config.new constructs a new object with attributes and blocks configured for the http_endpoint_config Terraform sub block.

Args:

• aws_secret_store_arn (string): Set the aws_secret_store_arn field on the resulting object.
• database_name (string): Set the database_name field on the resulting object. When null, the database_name field will be omitted from the resulting object.
• db_cluster_identifier (string): Set the db_cluster_identifier field on the resulting object.
• region (string): Set the region field on the resulting object. When null, the region field will be omitted from the resulting object.
• schema (string): Set the schema field on the resulting object. When null, the schema field will be omitted from the resulting object.

Returns:

• An attribute object that represents the http_endpoint_config sub block.