com.pulumi.aws.macie.CustomDataIdentifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.macie;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.macie.CustomDataIdentifierArgs;
import com.pulumi.aws.macie.inputs.CustomDataIdentifierState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * Provides a resource to manage an [AWS Macie Custom Data Identifier](https://docs.aws.amazon.com/macie/latest/APIReference/custom-data-identifiers-id.html).
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.macie2.Account;
 * import com.pulumi.aws.macie.CustomDataIdentifier;
 * import com.pulumi.aws.macie.CustomDataIdentifierArgs;
 * import com.pulumi.resources.CustomResourceOptions;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * 
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 * 
 *     public static void stack(Context ctx) {
 *         var example = new Account("example");
 * 
 *         var exampleCustomDataIdentifier = new CustomDataIdentifier("exampleCustomDataIdentifier", CustomDataIdentifierArgs.builder()
 *             .name("NAME OF CUSTOM DATA IDENTIFIER")
 *             .regex("[0-9]{3}-[0-9]{2}-[0-9]{4}")
 *             .description("DESCRIPTION")
 *             .maximumMatchDistance(10)
 *             .keywords("keyword")
 *             .ignoreWords("ignore")
 *             .build(), CustomResourceOptions.builder()
 *                 .dependsOn(test)
 *                 .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import `aws_macie2_custom_data_identifier` using the id. For example:
 * 
 * ```sh
 * $ pulumi import aws:macie/customDataIdentifier:CustomDataIdentifier example abcd1
 * ```
 * 
 */
@ResourceType(type="aws:macie/customDataIdentifier:CustomDataIdentifier")
public class CustomDataIdentifier extends com.pulumi.resources.CustomResource {
    /**
     * The Amazon Resource Name (ARN) of the custom data identifier.
     * 
     */
    @Export(name="arn", refs={String.class}, tree="[0]")
    private Output arn;

    /**
     * @return The Amazon Resource Name (ARN) of the custom data identifier.
     * 
     */
    public Output arn() {
        return this.arn;
    }
    /**
     * The date and time, in UTC and extended RFC 3339 format, when the Amazon Macie account was created.
     * 
     */
    @Export(name="createdAt", refs={String.class}, tree="[0]")
    private Output createdAt;

    /**
     * @return The date and time, in UTC and extended RFC 3339 format, when the Amazon Macie account was created.
     * 
     */
    public Output createdAt() {
        return this.createdAt;
    }
    /**
     * A custom description of the custom data identifier. The description can contain as many as 512 characters.
     * 
     */
    @Export(name="description", refs={String.class}, tree="[0]")
    private Output description;

    /**
     * @return A custom description of the custom data identifier. The description can contain as many as 512 characters.
     * 
     */
    public Output> description() {
        return Codegen.optional(this.description);
    }
    /**
     * An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as 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 characters. Ignore words are case sensitive.
     * 
     */
    @Export(name="ignoreWords", refs={List.class,String.class}, tree="[0,1]")
    private Output> ignoreWords;

    /**
     * @return An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as 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 characters. Ignore words are case sensitive.
     * 
     */
    public Output>> ignoreWords() {
        return Codegen.optional(this.ignoreWords);
    }
    /**
     * An array that lists specific character sequences (keywords), one of which must be within proximity (`maximum_match_distance`) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
     * 
     */
    @Export(name="keywords", refs={List.class,String.class}, tree="[0,1]")
    private Output> keywords;

    /**
     * @return An array that lists specific character sequences (keywords), one of which must be within proximity (`maximum_match_distance`) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive.
     * 
     */
    public Output>> keywords() {
        return Codegen.optional(this.keywords);
    }
    /**
     * The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
     * 
     */
    @Export(name="maximumMatchDistance", refs={Integer.class}, tree="[0]")
    private Output maximumMatchDistance;

    /**
     * @return The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
     * 
     */
    public Output maximumMatchDistance() {
        return this.maximumMatchDistance;
    }
    /**
     * A custom name for the custom data identifier. The name can contain as many as 128 characters. If omitted, the provider will assign a random, unique name. Conflicts with `name_prefix`.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return A custom name for the custom data identifier. The name can contain as many as 128 characters. If omitted, the provider will assign a random, unique name. Conflicts with `name_prefix`.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * Creates a unique name beginning with the specified prefix. Conflicts with `name`.
     * 
     */
    @Export(name="namePrefix", refs={String.class}, tree="[0]")
    private Output namePrefix;

    /**
     * @return Creates a unique name beginning with the specified prefix. Conflicts with `name`.
     * 
     */
    public Output namePrefix() {
        return this.namePrefix;
    }
    /**
     * The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
     * 
     */
    @Export(name="regex", refs={String.class}, tree="[0]")
    private Output regex;

    /**
     * @return The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
     * 
     */
    public Output> regex() {
        return Codegen.optional(this.regex);
    }
    /**
     * A map of key-value pairs that specifies the tags to associate with the custom data identifier.
     * 
     */
    @Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> tags;

    /**
     * @return A map of key-value pairs that specifies the tags to associate with the custom data identifier.
     * 
     */
    public Output>> tags() {
        return Codegen.optional(this.tags);
    }
    /**
     * @deprecated
     * Please use `tags` instead.
     * 
     */
    @Deprecated /* Please use `tags` instead. */
    @Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> tagsAll;

    public Output> tagsAll() {
        return this.tagsAll;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public CustomDataIdentifier(java.lang.String name) {
        this(name, CustomDataIdentifierArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public CustomDataIdentifier(java.lang.String name, @Nullable CustomDataIdentifierArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public CustomDataIdentifier(java.lang.String name, @Nullable CustomDataIdentifierArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:macie/customDataIdentifier:CustomDataIdentifier", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private CustomDataIdentifier(java.lang.String name, Output id, @Nullable CustomDataIdentifierState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:macie/customDataIdentifier:CustomDataIdentifier", name, state, makeResourceOptions(options, id), false);
    }

    private static CustomDataIdentifierArgs makeArgs(@Nullable CustomDataIdentifierArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? CustomDataIdentifierArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static CustomDataIdentifier get(java.lang.String name, Output id, @Nullable CustomDataIdentifierState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new CustomDataIdentifier(name, id, state, options);
    }
}