Struct aws_sdk_macie2::operation::create_custom_data_identifier::CreateCustomDataIdentifierInput

#[non_exhaustive]
pub struct CreateCustomDataIdentifierInput {
    pub client_token: Option<String>,
    pub description: Option<String>,
    pub ignore_words: Option<Vec<String>>,
    pub keywords: Option<Vec<String>>,
    pub maximum_match_distance: Option<i32>,
    pub name: Option<String>,
    pub regex: Option<String>,
    pub severity_levels: Option<Vec<SeverityLevel>>,
    pub tags: Option<HashMap<String, String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_token: Option<String>

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

description: Option<String>

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.

ignore_words: Option<Vec<String>>

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains 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 UTF-8 characters. Ignore words are case sensitive.

keywords: Option<Vec<String>>

An array that lists specific character sequences (keywords), one of which must precede and 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 UTF-8 characters. Keywords aren't case sensitive.

maximum_match_distance: Option<i32>

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 the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern 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.

name: Option<String>

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 this name, depending on the actions that they're allowed to perform in Amazon Macie.

regex: Option<String>

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

severity_levels: Option<Vec<SeverityLevel>>

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

tags: Option<HashMap<String, String>>

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Implementations

impl CreateCustomDataIdentifierInput

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

pub fn description(&self) -> Option<&str>

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.

pub fn ignore_words(&self) -> &[String]

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains 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 UTF-8 characters. Ignore words are case sensitive.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ignore_words.is_none().

pub fn keywords(&self) -> &[String]

An array that lists specific character sequences (keywords), one of which must precede and 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 UTF-8 characters. Keywords aren't case sensitive.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .keywords.is_none().

pub fn maximum_match_distance(&self) -> Option<i32>

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 the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern 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.

pub fn name(&self) -> Option<&str>

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 this name, depending on the actions that they're allowed to perform in Amazon Macie.

pub fn regex(&self) -> Option<&str>

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

pub fn severity_levels(&self) -> &[SeverityLevel]

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that match the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .severity_levels.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

impl CreateCustomDataIdentifierInput

pub fn builder() -> CreateCustomDataIdentifierInputBuilder

Creates a new builder-style object to manufacture CreateCustomDataIdentifierInput.

Trait Implementations

impl Clone for CreateCustomDataIdentifierInput

fn clone(&self) -> CreateCustomDataIdentifierInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCustomDataIdentifierInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateCustomDataIdentifierInput

fn eq(&self, other: &CreateCustomDataIdentifierInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateCustomDataIdentifierInput