Class CfnAllowList
A CloudFormation AWS::Macie::AllowList
.
Inherited Members
Namespace: Amazon.CDK.AWS.Macie
Assembly: Amazon.CDK.AWS.Macie.dll
Syntax (csharp)
public class CfnAllowList : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAllowList
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Macie::AllowList
resource specifies an allow list. In Amazon Macie , an allow list defines specific text or a text pattern for Macie to ignore when it inspects data sources for sensitive data. If data matches text or a text pattern in an allow list, Macie doesn’t report the data in sensitive data findings or sensitive data discovery results, even if the data matches the criteria of a custom data identifier or a managed data identifier. You can create and use allow lists in all the AWS Regions where Macie is currently available except the Asia Pacific (Osaka) Region.
Macie supports two types of allow lists:
This type of list typically contains specific words, phrases, and other kinds of character sequences that aren’t sensitive, aren't likely to change, and don’t necessarily adhere to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that exactly match a complete entry in the list. Macie treats each entry in the list as a string literal value. Matches aren't case sensitive.
This type of list is helpful if you want to specify text that isn’t sensitive but varies or is likely to change while also adhering to a common pattern. If you use this type of list, Macie doesn't report occurrences of text that completely match the pattern defined by the list.
For more information, see Defining sensitive data exceptions with allow lists in the Amazon Macie User Guide .
An AWS::Macie::Session
resource must exist for an AWS account before you can create an AWS::Macie::AllowList
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"
.
CloudformationResource: AWS::Macie::AllowList
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-allowlist.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Macie;
var cfnAllowList = new CfnAllowList(this, "MyCfnAllowList", new CfnAllowListProps {
Criteria = new CriteriaProperty {
Regex = "regex",
S3WordsList = new S3WordsListProperty {
BucketName = "bucketName",
ObjectKey = "objectKey"
}
},
Name = "name",
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnAllowList(Construct, String, ICfnAllowListProps) | Create a new |
CfnAllowList(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAllowList(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the allow list. |
AttrId | The unique identifier for the allow list. |
AttrStatus | The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Criteria | The criteria that specify the text or text pattern to ignore. |
Description | A custom description of the allow list. |
Name | A custom name for the allow list. |
Tags | An array of key-value pairs to apply to the allow list. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAllowList(Construct, String, ICfnAllowListProps)
Create a new AWS::Macie::AllowList
.
public CfnAllowList(Construct scope, string id, ICfnAllowListProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAllowListProps
- resource properties.
CfnAllowList(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAllowList(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAllowList(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAllowList(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the allow list.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The unique identifier for the allow list.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrStatus
The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
If the list's criteria specify a regular expression ( Regex
), this value is typically OK
. Macie can compile the expression. If the list's criteria specify an Amazon S3 object ( S3WordsList
), possible values are:
For more information, see Allow list options and requirements in the Amazon Macie User Guide .
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Criteria
The criteria that specify the text or text pattern to ignore.
public virtual object Criteria { get; set; }
Property Value
System.Object
Remarks
The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore ( S3WordsList
), or a regular expression ( Regex
) that defines a text pattern to ignore.
Description
A custom description of the allow list.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
The description can contain 1-512 characters.
Name
A custom name for the allow list.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name can contain 1-128 characters.
Tags
An array of key-value pairs to apply to the allow list.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>