@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:51.658Z") public class CfnCustomDataIdentifier extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnCustomDataIdentifier.Builder
A fluent builder for
CfnCustomDataIdentifier . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCustomDataIdentifier(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCustomDataIdentifier(Construct scope, java.lang.String id, CfnCustomDataIdentifierProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
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 .
public void setName(java.lang.String value)
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 .
public java.lang.String getRegex()
The expression can contain as many as 512 characters.
public void setRegex(java.lang.String value)
The expression can contain as many as 512 characters.
public java.lang.String getDescription()
The description can contain as many as 512 characters.
public void setDescription(java.lang.String value)
The description can contain as many as 512 characters.
public java.util.List<java.lang.String> getIgnoreWords()
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.
public void setIgnoreWords(java.util.List<java.lang.String> value)
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.
public java.util.List<java.lang.String> getKeywords()
The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.
public void setKeywords(java.util.List<java.lang.String> value)
The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.
public java.lang.Number getMaximumMatchDistance()
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.
public void setMaximumMatchDistance(java.lang.Number value)
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.