Struct aws_sdk_macie2::input::create_classification_job_input::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for CreateClassificationJobInput

Implementations

impl Builder

pub fn client_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_token(self, input: Option<String>) -> Self

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

pub fn custom_data_identifier_ids(self, input: impl Into<String>) -> Self

Appends an item to custom_data_identifier_ids.

To override the contents of this collection use set_custom_data_identifier_ids.

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

pub fn set_custom_data_identifier_ids(self, input: Option<Vec<String>>) -> Self

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

pub fn description(self, input: impl Into<String>) -> Self

A custom description of the job. The description can contain as many as 200 characters.

pub fn set_description(self, input: Option<String>) -> Self

A custom description of the job. The description can contain as many as 200 characters.

pub fn initial_run(self, input: bool) -> Self

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

pub fn set_initial_run(self, input: Option<bool>) -> Self

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

pub fn job_type(self, input: JobType) -> Self

The schedule for running the job. Valid values are:

• ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

• SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

pub fn set_job_type(self, input: Option<JobType>) -> Self

The schedule for running the job. Valid values are:

• ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.

• SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

pub fn managed_data_identifier_ids(self, input: impl Into<String>) -> Self

Appends an item to managed_data_identifier_ids.

To override the contents of this collection use set_managed_data_identifier_ids.

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

pub fn set_managed_data_identifier_ids(self, input: Option<Vec<String>>) -> Self

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

pub fn managed_data_identifier_selector(
    self,
    input: ManagedDataIdentifierSelector
) -> Self

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

• ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

• EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

• INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

• NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

pub fn set_managed_data_identifier_selector(
    self,
    input: Option<ManagedDataIdentifierSelector>
) -> Self

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

• ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.

• EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.

• INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.

• NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

pub fn name(self, input: impl Into<String>) -> Self

A custom name for the job. The name can contain as many as 500 characters.

pub fn set_name(self, input: Option<String>) -> Self

A custom name for the job. The name can contain as many as 500 characters.

pub fn s3_job_definition(self, input: S3JobDefinition) -> Self

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

pub fn set_s3_job_definition(self, input: Option<S3JobDefinition>) -> Self

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

pub fn sampling_percentage(self, input: i32) -> Self

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

pub fn set_sampling_percentage(self, input: Option<i32>) -> Self

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

pub fn schedule_frequency(self, input: JobScheduleFrequency) -> Self

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

pub fn set_schedule_frequency(self, input: Option<JobScheduleFrequency>) -> Self

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

A map of key-value pairs that specifies the tags to associate with the job.

A job 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.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

A map of key-value pairs that specifies the tags to associate with the job.

A job 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.

pub fn build(self) -> Result<CreateClassificationJobInput, BuildError>

Consumes the builder and constructs a CreateClassificationJobInput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder