CfnCustomDataIdentifierPropsMixin

class aws_cdk.mixins_preview.aws_macie.mixins.CfnCustomDataIdentifierPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-customdataidentifier.html

CloudformationResource:

AWS::Macie::CustomDataIdentifier

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_macie import mixins as macie_mixins

cfn_custom_data_identifier_props_mixin = macie_mixins.CfnCustomDataIdentifierPropsMixin(macie_mixins.CfnCustomDataIdentifierMixinProps(
    description="description",
    ignore_words=["ignoreWords"],
    keywords=["keywords"],
    maximum_match_distance=123,
    name="name",
    regex="regex",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Macie::CustomDataIdentifier.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'ignoreWords', 'keywords', 'maximumMatchDistance', 'name', 'regex', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental