Skip to content

Commit

Permalink
docs(glue): dataQualityRuleset
Browse files Browse the repository at this point in the history
  • Loading branch information
GlennChia committed May 26, 2023
1 parent c333d69 commit 7b22e90
Showing 1 changed file with 92 additions and 0 deletions.
92 changes: 92 additions & 0 deletions website/docs/r/glue_data_quality_ruleset.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
subcategory: "Glue"
layout: "aws"
page_title: "AWS: aws_glue_data_quality_ruleset"
description: |-
Provides a Glue Data Quality Ruleset.
---

# Resource: aws_glue_data_quality_ruleset

Provides a Glue Data Quality Ruleset Resource. You can refer to the [Glue Developer Guide](https://docs.aws.amazon.com/glue/latest/dg/glue-data-quality.html) for a full explanation of the Glue Data Quality Ruleset functionality

## Example Usage

### Basic

```terraform
resource "aws_glue_data_quality_ruleset" "example" {
name = "example"
ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
}
```

### With description

```terraform
resource "aws_glue_data_quality_ruleset" "example" {
name = "example"
description = "example"
ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
}
```

### With tags

```terraform
resource "aws_glue_data_quality_ruleset" "example" {
name = "example"
ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
tags = {
"hello" = "world"
}
}
```

### With target_table

```terraform
resource "aws_glue_data_quality_ruleset" "example" {
name = "example"
ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
target_table {
database_name = aws_glue_catalog_database.example.name
table_name = aws_glue_catalog_table.example.name
}
}
```

## Argument Reference

The following arguments are supported:

* `description` - (Optional) Description of the data quality ruleset.
* `name` - (Required, Forces new resource) Name of the data quality ruleset.
* `ruleset` - (Optional) A Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide.
* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
* `target_table` - (Optional, Forces new resource) A Configuration block specifying a target table associated with the data quality ruleset. See [`target_table`](#target_table) below.

### target_table

* `database_name` - (Required, Forces new resource) Name of the database where the AWS Glue table exists.
* `table_name` - (Required, Forces new resource) Name of the AWS Glue table.

## Attributes Reference

In addition to all arguments above, the following attributes are exported:

* `arn` - ARN of the Glue Data Quality Ruleset.
* `created_on` - The time and date that this data quality ruleset was created.
* `last_modified_on` - The time and date that this data quality ruleset was created.
* `recommendation_run_id` - When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block).

## Import

Glue Data Quality Ruleset can be imported using the `name`, e.g.,

```
$ terraform import aws_glue_data_quality_ruleset.example exampleName
```

0 comments on commit 7b22e90

Please sign in to comment.