Class CfnRuleset
Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.
Inherited Members
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRuleset : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnRuleset
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-ruleset.html
CloudformationResource: AWS::DataBrew::Ruleset
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataBrew;
var cfnRuleset = new CfnRuleset(this, "MyCfnRuleset", new CfnRulesetProps {
Name = "name",
Rules = new [] { new RuleProperty {
CheckExpression = "checkExpression",
Name = "name",
// the properties below are optional
ColumnSelectors = new [] { new ColumnSelectorProperty {
Name = "name",
Regex = "regex"
} },
Disabled = false,
SubstitutionMap = new [] { new SubstitutionValueProperty {
Value = "value",
ValueReference = "valueReference"
} },
Threshold = new ThresholdProperty {
Value = 123,
// the properties below are optional
Type = "type",
Unit = "unit"
}
} },
TargetArn = "targetArn",
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnRuleset(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRuleset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnRuleset(Construct, String, ICfnRulesetProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the ruleset. |
Name | The name of the ruleset. |
Rules | Contains metadata about the ruleset. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
TargetArn | The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRuleset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRuleset(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRuleset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRuleset(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnRuleset(Construct, String, ICfnRulesetProps)
public CfnRuleset(Construct scope, string id, ICfnRulesetProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnRulesetProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the ruleset.
public virtual string Description { get; set; }
Property Value
System.String
Name
The name of the ruleset.
public virtual string Name { get; set; }
Property Value
System.String
Rules
Contains metadata about the ruleset.
public virtual object Rules { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TargetArn
The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
public virtual string TargetArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>