software.amazon.awscdk.services.macie

Class CfnCustomDataIdentifier

java.lang.Object

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:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:51.658Z")
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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnCustomDataIdentifier(Construct scope,
                               java.lang.String id,
                               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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrId

public java.lang.String getAttrId()

The unique identifier for the custom data identifier.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.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

public void setName(java.lang.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

public java.lang.String getRegex()

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

The expression can contain as many as 512 characters.

setRegex

public void setRegex(java.lang.String value)

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

The expression can contain as many as 512 characters.

getDescription

public java.lang.String getDescription()

The description of the custom data identifier.

The description can contain as many as 512 characters.

setDescription

public void setDescription(java.lang.String value)

The description of the custom data identifier.

The description can contain as many as 512 characters.

getIgnoreWords

public java.util.List<java.lang.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

public void setIgnoreWords(java.util.List<java.lang.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

public java.util.List<java.lang.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

public void setKeywords(java.util.List<java.lang.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

public java.lang.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

public void setMaximumMatchDistance(java.lang.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.