DataQualityRuleset class

Provides a Glue Data Quality Ruleset Resource. You can refer to the Glue Developer Guide for a full explanation of the Glue Data Quality Ruleset functionality

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.DataQualityRuleset("example", {
    name: "example",
    ruleset: "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.DataQualityRuleset("example",
    name="example",
    ruleset="Rules = [Completeness \"colA\" between 0.4 and 0.8]")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.DataQualityRuleset("example", new()
    {
        Name = "example",
        Ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewDataQualityRuleset(ctx, "example", &glue.DataQualityRulesetArgs{
			Name:    pulumi.String("example"),
			Ruleset: pulumi.String("Rules = [Completeness \"colA\" between 0.4 and 0.8]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_dataqualityruleset" "example" {
  name    = "example"
  ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.DataQualityRuleset;
import com.pulumi.aws.glue.DataQualityRulesetArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataQualityRuleset("example", DataQualityRulesetArgs.builder()
            .name("example")
            .ruleset("Rules = [Completeness \"colA\" between 0.4 and 0.8]")
            .build());

    }
}
resources:
  example:
    type: aws:glue:DataQualityRuleset
    properties:
      name: example
      ruleset: Rules = [Completeness "colA" between 0.4 and 0.8]

With description

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.DataQualityRuleset("example", {
    name: "example",
    description: "example",
    ruleset: "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.DataQualityRuleset("example",
    name="example",
    description="example",
    ruleset="Rules = [Completeness \"colA\" between 0.4 and 0.8]")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.DataQualityRuleset("example", new()
    {
        Name = "example",
        Description = "example",
        Ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewDataQualityRuleset(ctx, "example", &glue.DataQualityRulesetArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("example"),
			Ruleset:     pulumi.String("Rules = [Completeness \"colA\" between 0.4 and 0.8]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_dataqualityruleset" "example" {
  name        = "example"
  description = "example"
  ruleset     = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.DataQualityRuleset;
import com.pulumi.aws.glue.DataQualityRulesetArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataQualityRuleset("example", DataQualityRulesetArgs.builder()
            .name("example")
            .description("example")
            .ruleset("Rules = [Completeness \"colA\" between 0.4 and 0.8]")
            .build());

    }
}
resources:
  example:
    type: aws:glue:DataQualityRuleset
    properties:
      name: example
      description: example
      ruleset: Rules = [Completeness "colA" between 0.4 and 0.8]

With tags

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.DataQualityRuleset("example", {
    name: "example",
    ruleset: "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
    tags: {
        hello: "world",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.glue.DataQualityRuleset("example",
    name="example",
    ruleset="Rules = [Completeness \"colA\" between 0.4 and 0.8]",
    tags={
        "hello": "world",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.DataQualityRuleset("example", new()
    {
        Name = "example",
        Ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
        Tags =
        {
            { "hello", "world" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewDataQualityRuleset(ctx, "example", &glue.DataQualityRulesetArgs{
			Name:    pulumi.String("example"),
			Ruleset: pulumi.String("Rules = [Completeness \"colA\" between 0.4 and 0.8]"),
			Tags: pulumi.StringMap{
				"hello": pulumi.String("world"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_dataqualityruleset" "example" {
  name    = "example"
  ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
  tags = {
    "hello" = "world"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.DataQualityRuleset;
import com.pulumi.aws.glue.DataQualityRulesetArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataQualityRuleset("example", DataQualityRulesetArgs.builder()
            .name("example")
            .ruleset("Rules = [Completeness \"colA\" between 0.4 and 0.8]")
            .tags(Map.of("hello", "world"))
            .build());

    }
}
resources:
  example:
    type: aws:glue:DataQualityRuleset
    properties:
      name: example
      ruleset: Rules = [Completeness "colA" between 0.4 and 0.8]
      tags:
        hello: world

With targetTable

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.DataQualityRuleset("example", {
    targetTable: {
        databaseName: exampleAwsGlueCatalogDatabase.name,
        tableName: exampleAwsGlueCatalogTable.name,
    },
    name: "example",
    ruleset: "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
});
import pulumi
import pulumi_aws as aws

example = aws.glue.DataQualityRuleset("example",
    target_table={
        "database_name": example_aws_glue_catalog_database["name"],
        "table_name": example_aws_glue_catalog_table["name"],
    },
    name="example",
    ruleset="Rules = [Completeness \"colA\" between 0.4 and 0.8]")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Glue.DataQualityRuleset("example", new()
    {
        TargetTable = new Aws.Glue.Inputs.DataQualityRulesetTargetTableArgs
        {
            DatabaseName = exampleAwsGlueCatalogDatabase.Name,
            TableName = exampleAwsGlueCatalogTable.Name,
        },
        Name = "example",
        Ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := glue.NewDataQualityRuleset(ctx, "example", &glue.DataQualityRulesetArgs{
			TargetTable: &glue.DataQualityRulesetTargetTableArgs{
				DatabaseName: pulumi.Any(exampleAwsGlueCatalogDatabase.Name),
				TableName:    pulumi.Any(exampleAwsGlueCatalogTable.Name),
			},
			Name:    pulumi.String("example"),
			Ruleset: pulumi.String("Rules = [Completeness \"colA\" between 0.4 and 0.8]"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_glue_dataqualityruleset" "example" {
  target_table = {
    database_name = exampleAwsGlueCatalogDatabase.name
    table_name    = exampleAwsGlueCatalogTable.name
  }
  name    = "example"
  ruleset = "Rules = [Completeness \"colA\" between 0.4 and 0.8]"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.DataQualityRuleset;
import com.pulumi.aws.glue.DataQualityRulesetArgs;
import com.pulumi.aws.glue.inputs.DataQualityRulesetTargetTableArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DataQualityRuleset("example", DataQualityRulesetArgs.builder()
            .targetTable(DataQualityRulesetTargetTableArgs.builder()
                .databaseName(exampleAwsGlueCatalogDatabase.name())
                .tableName(exampleAwsGlueCatalogTable.name())
                .build())
            .name("example")
            .ruleset("Rules = [Completeness \"colA\" between 0.4 and 0.8]")
            .build());

    }
}
resources:
  example:
    type: aws:glue:DataQualityRuleset
    properties:
      targetTable:
        databaseName: ${exampleAwsGlueCatalogDatabase.name}
        tableName: ${exampleAwsGlueCatalogTable.name}
      name: example
      ruleset: Rules = [Completeness "colA" between 0.4 and 0.8]

Import

Using pulumi import, import Glue Data Quality Ruleset using the name. For example:

$ pulumi import aws:glue/dataQualityRuleset:DataQualityRuleset example exampleName

Constructors

DataQualityRuleset(String name, {DataQualityRulesetArgs? args, CustomResourceOptions? options})
Creates a new DataQualityRuleset. name The Pulumi resource name. args Arguments used to configure this DataQualityRuleset. The set of arguments for DataQualityRuleset. options Resource options controlling this resource's behavior.
DataQualityRuleset.reference(String urn)
Creates a typed reference to an existing DataQualityRuleset resource.

Properties

arn ↔ Output<String>
ARN of the Glue Data Quality Ruleset.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdOn ↔ Output<String>
The time and date that this data quality ruleset was created.
latefinal
description ↔ Output<String?>
Description of the data quality ruleset.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastModifiedOn ↔ Output<String>
The time and date that this data quality ruleset was created.
latefinal
name ↔ Output<String>
Name of the data quality ruleset.
latefinal
recommendationRunId ↔ Output<String>
When a ruleset was created from a recommendation run, this run ID is generated to link the two together.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
ruleset ↔ Output<String>
A Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
targetTable ↔ Output<DataQualityRulesetTargetTable?>
A Configuration block specifying a target table associated with the data quality ruleset. See targetTable below.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DataQualityRulesetState? state, CustomResourceOptions? options}) → DataQualityRuleset
Gets an existing DataQualityRuleset resource's state with the given name and id.