@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.476Z") public class CfnCustomDataIdentifier extends CfnResource implements IInspectable
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"
.
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()
A custom description of the custom data identifier.
|
java.util.List<java.lang.String> |
getIgnoreWords()
An array of character sequences ( *ignore words* ) to exclude from the results.
|
java.util.List<java.lang.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.
|
java.lang.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` ).
|
java.lang.String |
getName()
A custom name for the custom data identifier.
|
java.lang.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 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)
A custom description of the custom data identifier.
|
void |
setIgnoreWords(java.util.List<java.lang.String> value)
An array of character sequences ( *ignore words* ) to exclude from the results.
|
void |
setKeywords(java.util.List<java.lang.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(java.lang.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(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 text 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()
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 .
public void setName(java.lang.String value)
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 .
public java.lang.String getRegex()
The expression can contain 1-512 characters.
public void setRegex(java.lang.String value)
The expression can contain 1-512 characters.
public java.lang.String getDescription()
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 .
public void setDescription(java.lang.String value)
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 .
public java.util.List<java.lang.String> getIgnoreWords()
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.
public void setIgnoreWords(java.util.List<java.lang.String> value)
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.
public java.util.List<java.lang.String> getKeywords()
The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
public void setKeywords(java.util.List<java.lang.String> value)
The array can contain 1-50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.
public java.lang.Number getMaximumMatchDistance()
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.
public void setMaximumMatchDistance(java.lang.Number value)
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.