Package com.pulumi.aws.glue

Class DataQualityRuleset

  • public class DataQualityRuleset
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ### With description 
     
 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());
 
     }
 }
    ### With tags 
     
 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());
 
     }
 }
    ### With targetTable 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Glue Data Quality Ruleset using the `name`. For example: ```sh $ pulumi import aws:glue/dataQualityRuleset:DataQualityRuleset example exampleName ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdOn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static DataQualityRuleset get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DataQualityRulesetState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastModifiedOn()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> recommendationRunId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> ruleset()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<DataQualityRulesetTargetTable>> targetTable()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DataQualityRuleset

        public DataQualityRuleset​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • DataQualityRuleset

        public DataQualityRuleset​(java.lang.String name,
                          DataQualityRulesetArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • DataQualityRuleset

        public DataQualityRuleset​(java.lang.String name,
                          DataQualityRulesetArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Glue Data Quality Ruleset.

      • createdOn

        public com.pulumi.core.Output<java.lang.String> createdOn()
        Returns:
        Time and date that this data quality ruleset was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the data quality ruleset.

      • lastModifiedOn

        public com.pulumi.core.Output<java.lang.String> lastModifiedOn()
        Returns:
        Time and date that this data quality ruleset was created.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the data quality ruleset.

      • recommendationRunId

        public com.pulumi.core.Output<java.lang.String> recommendationRunId()
        Returns:
        When a ruleset was created from a recommendation run, this run ID is generated to link the two together.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • ruleset

        public com.pulumi.core.Output<java.lang.String> ruleset()
        Returns:
        Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetTable

        public com.pulumi.core.Output<java.util.Optional<DataQualityRulesetTargetTable>> targetTable()
        Returns:
        Configuration block specifying a target table associated with the data quality ruleset. See `targetTable` Block below.

      • get

        public static DataQualityRuleset get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     DataQualityRulesetState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.