software.amazon.awscdk.services.macie

Class CfnCustomDataIdentifier

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.macie.CfnCustomDataIdentifier

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.938Z")
 @Stability(value=Stable)
public class CfnCustomDataIdentifier
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Macie::CustomDataIdentifier`.

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:

• Keywords , which are words or phrases that must be in proximity of text that matches the regex, or
• Ignore words , which are words or phrases to exclude from the results.

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" .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.macie.*;
 CfnCustomDataIdentifier cfnCustomDataIdentifier = CfnCustomDataIdentifier.Builder.create(this, "MyCfnCustomDataIdentifier")
         .name("name")
         .regex("regex")
         // the properties below are optional
         .description("description")
         .ignoreWords(List.of("ignoreWords"))
         .keywords(List.of("keywords"))
         .maximumMatchDistance(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCustomDataIdentifier.Builder A fluent builder for CfnCustomDataIdentifier.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomDataIdentifier(Construct scope, String id, CfnCustomDataIdentifierProps props) Create a new `AWS::Macie::CustomDataIdentifier`.
protected	CfnCustomDataIdentifier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomDataIdentifier(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the custom data identifier.
String	getAttrId() The unique identifier for the custom data identifier.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A custom description of the custom data identifier.
List<String>	getIgnoreWords() An array of character sequences ( *ignore words* ) to exclude from the results.
List<String>	getKeywords() An array of character sequences ( *keywords* ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.
Number	getMaximumMatchDistance() 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` ).
String	getName() A custom name for the custom data identifier.
String	getRegex() The regular expression ( *regex* ) that defines the text pattern to match.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A custom description of the custom data identifier.
void	setIgnoreWords(List<String> value) An array of character sequences ( *ignore words* ) to exclude from the results.
void	setKeywords(List<String> value) An array of character sequences ( *keywords* ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.
void	setMaximumMatchDistance(Number value) 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` ).
void	setName(String value) A custom name for the custom data identifier.
void	setRegex(String value) The regular expression ( *regex* ) that defines the text pattern to match.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomDataIdentifier

protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObjectRef objRef)

CfnCustomDataIdentifier

protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCustomDataIdentifier

@Stability(value=Stable)
public CfnCustomDataIdentifier(@NotNull
                                                        Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        CfnCustomDataIdentifierProps props)

Create a new `AWS::Macie::CustomDataIdentifier`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The unique identifier for the custom data identifier.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A custom name for the custom data identifier. The name can contain 1-128 characters.

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 .

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A custom name for the custom data identifier. The name can contain 1-128 characters.

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 .

getRegex

@Stability(value=Stable)
 @NotNull
public String getRegex()

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

The expression can contain 1-512 characters.

setRegex

@Stability(value=Stable)
public void setRegex(@NotNull
                                              String value)

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

The expression can contain 1-512 characters.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A custom description of the custom data identifier. The description can contain 1-512 characters.

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 .

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A custom description of the custom data identifier. The description can contain 1-512 characters.

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 .

getIgnoreWords

@Stability(value=Stable)
 @Nullable
public List<String> getIgnoreWords()

An array of character sequences ( *ignore words* ) to exclude from the results.

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.

setIgnoreWords

@Stability(value=Stable)
public void setIgnoreWords(@Nullable
                                                    List<String> value)

An array of character sequences ( *ignore words* ) to exclude from the results.

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.

getKeywords

@Stability(value=Stable)
 @Nullable
public List<String> getKeywords()

An array of character sequences ( *keywords* ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.

The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

setKeywords

@Stability(value=Stable)
public void setKeywords(@Nullable
                                                 List<String> value)

An array of character sequences ( *keywords* ), one of which must precede and be in proximity ( `MaximumMatchDistance` ) of the regular expression ( `Regex` ) to match.

The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

getMaximumMatchDistance

@Stability(value=Stable)
 @Nullable
public Number getMaximumMatchDistance()

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` ).

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.

setMaximumMatchDistance

@Stability(value=Stable)
public void setMaximumMatchDistance(@Nullable
                                                             Number value)

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` ).

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.