Class CfnCustomDataIdentifier
A CloudFormation AWS::Macie::CustomDataIdentifier
.
Inherited Members
Namespace: Amazon.CDK.AWS.Macie
Assembly: Amazon.CDK.AWS.Macie.dll
Syntax (csharp)
public class CfnCustomDataIdentifier : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCustomDataIdentifier
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Macie::CustomDataIdentifier
resource specifies a custom data identifier. A custom data identifier is a set of custom criteria for Amazon Macie to use when it inspects data sources for sensitive data. The criteria consist of a regular expression ( regex ) that defines a text pattern to match and, optionally, character sequences and a proximity rule that refine the results. The character sequences can be:
By using custom data identifiers, you can supplement the managed data identifiers that Macie provides and detect sensitive data that reflects your particular scenarios, intellectual property, or proprietary data. For more information, see Building custom data identifiers in the Amazon Macie User Guide .
An AWS::Macie::Session
resource must exist for an AWS account before you can create an AWS::Macie::CustomDataIdentifier
resource for the account. Use a DependsOn attribute to ensure that an AWS::Macie::Session
resource is created before other Macie resources are created for an account. For example, "DependsOn": "Session"
.
CloudformationResource: AWS::Macie::CustomDataIdentifier
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;
var 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 |
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 | A custom description of the custom data identifier. The description can contain 1-512 characters. |
IgnoreWords | An array of character sequences ( ignore words ) to exclude from the results. |
Keywords | An array of character sequences ( keywords ), one of which must precede and be in proximity ( |
MaximumMatchDistance | The maximum number of characters that can exist between the end of at least one complete character sequence specified by the |
Name | A custom name for the custom data identifier. The name can contain 1-128 characters. |
Regex | The regular expression ( regex ) that defines the text 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
Description
A custom description of the custom data identifier. The description can contain 1-512 characters.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Avoid including sensitive data in the description. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie .
IgnoreWords
An array of character sequences ( ignore words ) to exclude from the results.
public virtual string[] IgnoreWords { get; set; }
Property Value
System.String[]
Remarks
If text matches the regular expression ( Regex
) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results.
The array can contain 1-10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.
Keywords
An array of character sequences ( keywords ), one of which must precede and be in proximity ( MaximumMatchDistance
) of the regular expression ( Regex
) to match.
public virtual string[] Keywords { get; set; }
Property Value
System.String[]
Remarks
The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
MaximumMatchDistance
The maximum number of characters that can exist between the end of at least one complete character sequence specified by the Keywords
array and the end of text that matches the regular expression ( Regex
).
public virtual Nullable<double> MaximumMatchDistance { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result.
The distance can be 1-300 characters. The default value is 50.
Name
A custom name for the custom data identifier. The name can contain 1-128 characters.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Avoid including sensitive data in the name of a custom data identifier. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie .
Regex
The regular expression ( regex ) that defines the text pattern to match.
public virtual string Regex { get; set; }
Property Value
System.String
Remarks
The expression can contain 1-512 characters.
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>