software.amazon.awscdk.services.macie

Class CfnCustomDataIdentifier

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.macie.CfnCustomDataIdentifier

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.744Z")
 @Stability(value=Stable)
public class CfnCustomDataIdentifier
extends CfnResource
implements IInspectable

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

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

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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(software.constructs.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() The description of the custom data identifier.
List<String>	getIgnoreWords() An array that lists specific character sequences (ignore words) to exclude from the results.
List<String>	getKeywords() An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
Number	getMaximumMatchDistance() The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
String	getName() A custom name for the custom data identifier.
String	getRegex() The regular expression ( *regex* ) that defines the 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) The description of the custom data identifier.
void	setIgnoreWords(List<String> value) An array that lists specific character sequences (ignore words) to exclude from the results.
void	setKeywords(List<String> value) An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
void	setMaximumMatchDistance(Number value) The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
void	setName(String value) A custom name for the custom data identifier.
void	setRegex(String value) The regular expression ( *regex* ) that defines the pattern to match.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                                        software.constructs.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 as many as 128 characters.

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 .

setName

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

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

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 .

getRegex

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

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

The expression can contain as many as 512 characters.

setRegex

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

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

The expression can contain as many as 512 characters.

getDescription

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

The description of the custom data identifier.

The description can contain as many as 512 characters.

setDescription

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

The description of the custom data identifier.

The description can contain as many as 512 characters.

getIgnoreWords

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

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

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.

setIgnoreWords

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

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

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.

getKeywords

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

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

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

setKeywords

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

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

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

getMaximumMatchDistance

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

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

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.

setMaximumMatchDistance

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

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

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.