Skip to content

Commit

Permalink
[docs]: appsync/datasource: add missing documentation (#32443)
Browse files Browse the repository at this point in the history
* aws_appsync_datasource: format doc headings and links

* aws_appsync_datasource: document additional attributes
  • Loading branch information
johnsonaj committed Jul 10, 2023
1 parent 3976e58 commit 9025260
Showing 1 changed file with 28 additions and 20 deletions.
48 changes: 28 additions & 20 deletions website/docs/r/appsync_datasource.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -81,78 +81,86 @@ The following arguments are supported:
* `name` - (Required) User-supplied name for the data source.
* `type` - (Required) Type of the Data Source. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`, `RELATIONAL_DATABASE`, `AMAZON_EVENTBRIDGE`.
* `description` - (Optional) Description of the data source.
* `dynamodb_config` - (Optional) DynamoDB settings. See [below](#dynamodb_config)
* `elasticsearch_config` - (Optional) Amazon Elasticsearch settings. See [below](#elasticsearch_config)
* `event_bridge_config` - (Optional) AWS EventBridge settings. See [below](#event_bridge_config)
* `http_config` - (Optional) HTTP settings. See [below](#http_config)
* `lambda_config` - (Optional) AWS Lambda settings. See [below](#lambda_config)
* `opensearchservice_config` - (Optional) Amazon OpenSearch Service settings. See [below](#opensearchservice_config)
* `relational_database_config` (Optional) AWS RDS settings. See [Relational Database Config](#relational_database_config)
* `dynamodb_config` - (Optional) DynamoDB settings. See [DynamoDB Config](#dynamodb-config)
* `elasticsearch_config` - (Optional) Amazon Elasticsearch settings. See [ElasticSearch Config](#elasticsearch-config)
* `event_bridge_config` - (Optional) AWS EventBridge settings. See [Event Bridge Config](#event-bridge-config)
* `http_config` - (Optional) HTTP settings. See [HTTP Config](#http-config)
* `lambda_config` - (Optional) AWS Lambda settings. See [Lambda Config](#lambda-config)
* `opensearchservice_config` - (Optional) Amazon OpenSearch Service settings. See [OpenSearch Service Config](#opensearch-service-config)
* `relational_database_config` (Optional) AWS RDS settings. See [Relational Database Config](#relational-database-config)
* `service_role_arn` - (Optional) IAM service role ARN for the data source.

### dynamodb_config
### DynamoDB Config

The following arguments are supported:

* `table_name` - (Required) Name of the DynamoDB table.
* `region` - (Optional) AWS region of the DynamoDB table. Defaults to current region.
* `use_caller_credentials` - (Optional) Set to `true` to use Amazon Cognito credentials with this data source.
* `delta_sync_config` - (Optional) The DeltaSyncConfig for a versioned data source. See [Delta Sync Config](#delta-sync-config)
* `versioned` - (Optional) Detects Conflict Detection and Resolution with this data source.

### elasticsearch_config
### Delta Sync Config

* `base_table_ttl` - (Optional) The number of minutes that an Item is stored in the data source.
* `delta_sync_table_name` - (Required) The table name.
* `delta_sync_table_ttl` - (Optional) The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

### ElasticSearch Config

The following arguments are supported:

* `endpoint` - (Required) HTTP endpoint of the Elasticsearch domain.
* `region` - (Optional) AWS region of Elasticsearch domain. Defaults to current region.

### event_bridge_config
### Event Bridge Config

The following arguments are supported:

* `event_bus_arn` - (Required) ARN for the EventBridge bus.

### http_config
### HTTP Config

The following arguments are supported:

* `endpoint` - (Required) HTTP URL.
* `authorization_config` - (Optional) Authorization configuration in case the HTTP endpoint requires authorization. See [Authorization Config](#authorization_config).
* `authorization_config` - (Optional) Authorization configuration in case the HTTP endpoint requires authorization. See [Authorization Config](#authorization-config).

#### authorization_config
#### Authorization Config

The following arguments are supported:

* `authorization_type` - (Optional) Authorization type that the HTTP endpoint requires. Default values is `AWS_IAM`.
* `aws_iam_config` - (Optional) Identity and Access Management (IAM) settings. See [AWS IAM Config](#aws_iam_config).
* `aws_iam_config` - (Optional) Identity and Access Management (IAM) settings. See [AWS IAM Config](#aws-iam-config).

##### aws_iam_config
##### AWS IAM Config

The following arguments are supported:

* `signing_region` - (Optional) Signing Amazon Web Services Region for IAM authorization.
* `signing_service_name`- (Optional) Signing service name for IAM authorization.

### lambda_config
### Lambda Config

The following arguments are supported:

* `function_arn` - (Required) ARN for the Lambda function.

### opensearchservice_config
### OpenSearch Service Config

The following arguments are supported:

* `endpoint` - (Required) HTTP endpoint of the OpenSearch domain.
* `region` - (Optional) AWS region of the OpenSearch domain. Defaults to current region.

### relational_database_config
### Relational Database Config

The following arguments are supported:

* `http_endpoint_config` - (Required) Amazon RDS HTTP endpoint configuration. See [HTTP Endpoint Config](#http_endpoint_config).
* `http_endpoint_config` - (Required) Amazon RDS HTTP endpoint configuration. See [HTTP Endpoint Config](#http-endpoint-config).
* `source_type` - (Optional) Source type for the relational database. Valid values: `RDS_HTTP_ENDPOINT`.

#### http_endpoint_config
#### HTTP Endpoint Config

The following arguments are supported:

Expand Down

0 comments on commit 9025260

Please sign in to comment.