Class CfnCustomDataIdentifier

A CloudFormation AWS::Macie::CustomDataIdentifier.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnCustomDataIdentifier

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Macie

Assembly: Amazon.CDK.AWS.Macie.dll

Syntax (csharp)

public class CfnCustomDataIdentifier : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnCustomDataIdentifier
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

The AWS::Macie::CustomDataIdentifier resource is a set of criteria that you define to detect sensitive data in one or more data sources. Each identifier specifies a regular expression ( regex ) that defines a text pattern to match in the data. It can also specify character sequences, such as words and phrases, and a proximity rule that refine the analysis of a data source. By using custom data identifiers, you can tailor your analysis to meet your organization's specific needs and supplement the built-in, managed data identifiers that Amazon Macie provides.

A Session must exist for the account before you can create a CustomDataIdentifier . Use a DependsOn attribute to ensure that the Session is created before the other resources. For example, "DependsOn: Session" .

CloudformationResource: AWS::Macie::CustomDataIdentifier

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html

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.Macie;

CfnCustomDataIdentifier cfnCustomDataIdentifier = new CfnCustomDataIdentifier(this, "MyCfnCustomDataIdentifier", new CfnCustomDataIdentifierProps {
    Name = "name",
    Regex = "regex",

    // the properties below are optional
    Description = "description",
    IgnoreWords = new [] { "ignoreWords" },
    Keywords = new [] { "keywords" },
    MaximumMatchDistance = 123
});

Synopsis

Constructors

CfnCustomDataIdentifier(Construct, String, ICfnCustomDataIdentifierProps)	Create a new `AWS::Macie::CustomDataIdentifier`.
CfnCustomDataIdentifier(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnCustomDataIdentifier(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn	The Amazon Resource Name (ARN) of the custom data identifier.
AttrId	The unique identifier for the custom data identifier.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Description	The description of the custom data identifier.
IgnoreWords	An array that lists specific character sequences (ignore words) to exclude from the results.
Keywords	An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
MaximumMatchDistance	The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
Name	A custom name for the custom data identifier. The name can contain as many as 128 characters.
Regex	The regular expression ( regex ) that defines the pattern to match.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnCustomDataIdentifier(Construct, String, ICfnCustomDataIdentifierProps)

Create a new AWS::Macie::CustomDataIdentifier.

public CfnCustomDataIdentifier(Construct scope, string id, ICfnCustomDataIdentifierProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnCustomDataIdentifierProps

resource properties.

CfnCustomDataIdentifier(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnCustomDataIdentifier(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnCustomDataIdentifier(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnCustomDataIdentifier(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the custom data identifier.

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

The unique identifier for the custom data identifier.

public virtual string AttrId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Id

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

CfnResource.CfnProperties

Description

The description of the custom data identifier.

public virtual string Description { get; set; }

Property Value

System.String

Remarks

The description can contain as many as 512 characters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-description

IgnoreWords

An array that lists specific character sequences (ignore words) to exclude from the results.

public virtual string[] IgnoreWords { get; set; }

Property Value

System.String[]

Remarks

If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-ignorewords

Keywords

An array that lists specific character sequences (keywords), one of which must be within proximity ( MaximumMatchDistance ) of the regular expression to match.

public virtual string[] Keywords { get; set; }

Property Value

System.String[]

Remarks

The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-keywords

MaximumMatchDistance

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the Keywords array.

public virtual Nullable<double> MaximumMatchDistance { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-maximummatchdistance

Name

A custom name for the custom data identifier. The name can contain as many as 128 characters.

public virtual string Name { get; set; }

Property Value

System.String

Remarks

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-name

Regex

The regular expression ( regex ) that defines the pattern to match.

public virtual string Regex { get; set; }

Property Value

System.String

Remarks

The expression can contain as many as 512 characters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html#cfn-macie-customdataidentifier-regex

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable