All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.aws.comprehend.EntityRecognizerArgs Maven / Gradle / Ivy

Go to download

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

There is a newer version: 6.60.0-alpha.1731982519
Show 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.comprehend;

import com.pulumi.aws.comprehend.inputs.EntityRecognizerInputDataConfigArgs;
import com.pulumi.aws.comprehend.inputs.EntityRecognizerVpcConfigArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class EntityRecognizerArgs extends com.pulumi.resources.ResourceArgs {

    public static final EntityRecognizerArgs Empty = new EntityRecognizerArgs();

    /**
     * The ARN for an IAM Role which allows Comprehend to read the training and testing data.
     * 
     */
    @Import(name="dataAccessRoleArn", required=true)
    private Output dataAccessRoleArn;

    /**
     * @return The ARN for an IAM Role which allows Comprehend to read the training and testing data.
     * 
     */
    public Output dataAccessRoleArn() {
        return this.dataAccessRoleArn;
    }

    /**
     * Configuration for the training and testing data.
     * See the `input_data_config` Configuration Block section below.
     * 
     */
    @Import(name="inputDataConfig", required=true)
    private Output inputDataConfig;

    /**
     * @return Configuration for the training and testing data.
     * See the `input_data_config` Configuration Block section below.
     * 
     */
    public Output inputDataConfig() {
        return this.inputDataConfig;
    }

    /**
     * Two-letter language code for the language.
     * One of `en`, `es`, `fr`, `it`, `de`, or `pt`.
     * 
     */
    @Import(name="languageCode", required=true)
    private Output languageCode;

    /**
     * @return Two-letter language code for the language.
     * One of `en`, `es`, `fr`, `it`, `de`, or `pt`.
     * 
     */
    public Output languageCode() {
        return this.languageCode;
    }

    /**
     * The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
     * 
     */
    @Import(name="modelKmsKeyId")
    private @Nullable Output modelKmsKeyId;

    /**
     * @return The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
     * 
     */
    public Optional> modelKmsKeyId() {
        return Optional.ofNullable(this.modelKmsKeyId);
    }

    /**
     * Name for the Entity Recognizer.
     * Has a maximum length of 63 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * 
     * The following arguments are optional:
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return Name for the Entity Recognizer.
     * Has a maximum length of 63 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * 
     * The following arguments are optional:
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * A map of tags to assign to the resource. If configured with a provider `default_tags` Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    @Import(name="tags")
    private @Nullable Output> tags;

    /**
     * @return A map of tags to assign to the resource. If configured with a provider `default_tags` Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    public Optional>> tags() {
        return Optional.ofNullable(this.tags);
    }

    /**
     * Name for the version of the Entity Recognizer.
     * Each version must have a unique name within the Entity Recognizer.
     * If omitted, the provider will assign a random, unique version name.
     * If explicitly set to `""`, no version name will be set.
     * Has a maximum length of 63 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * Conflicts with `version_name_prefix`.
     * 
     */
    @Import(name="versionName")
    private @Nullable Output versionName;

    /**
     * @return Name for the version of the Entity Recognizer.
     * Each version must have a unique name within the Entity Recognizer.
     * If omitted, the provider will assign a random, unique version name.
     * If explicitly set to `""`, no version name will be set.
     * Has a maximum length of 63 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * Conflicts with `version_name_prefix`.
     * 
     */
    public Optional> versionName() {
        return Optional.ofNullable(this.versionName);
    }

    /**
     * Creates a unique version name beginning with the specified prefix.
     * Has a maximum length of 37 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * Conflicts with `version_name`.
     * 
     */
    @Import(name="versionNamePrefix")
    private @Nullable Output versionNamePrefix;

    /**
     * @return Creates a unique version name beginning with the specified prefix.
     * Has a maximum length of 37 characters.
     * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
     * Conflicts with `version_name`.
     * 
     */
    public Optional> versionNamePrefix() {
        return Optional.ofNullable(this.versionNamePrefix);
    }

    /**
     * ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
     * 
     */
    @Import(name="volumeKmsKeyId")
    private @Nullable Output volumeKmsKeyId;

    /**
     * @return ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
     * 
     */
    public Optional> volumeKmsKeyId() {
        return Optional.ofNullable(this.volumeKmsKeyId);
    }

    /**
     * Configuration parameters for VPC to contain Entity Recognizer resources.
     * See the `vpc_config` Configuration Block section below.
     * 
     */
    @Import(name="vpcConfig")
    private @Nullable Output vpcConfig;

    /**
     * @return Configuration parameters for VPC to contain Entity Recognizer resources.
     * See the `vpc_config` Configuration Block section below.
     * 
     */
    public Optional> vpcConfig() {
        return Optional.ofNullable(this.vpcConfig);
    }

    private EntityRecognizerArgs() {}

    private EntityRecognizerArgs(EntityRecognizerArgs $) {
        this.dataAccessRoleArn = $.dataAccessRoleArn;
        this.inputDataConfig = $.inputDataConfig;
        this.languageCode = $.languageCode;
        this.modelKmsKeyId = $.modelKmsKeyId;
        this.name = $.name;
        this.tags = $.tags;
        this.versionName = $.versionName;
        this.versionNamePrefix = $.versionNamePrefix;
        this.volumeKmsKeyId = $.volumeKmsKeyId;
        this.vpcConfig = $.vpcConfig;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(EntityRecognizerArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private EntityRecognizerArgs $;

        public Builder() {
            $ = new EntityRecognizerArgs();
        }

        public Builder(EntityRecognizerArgs defaults) {
            $ = new EntityRecognizerArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param dataAccessRoleArn The ARN for an IAM Role which allows Comprehend to read the training and testing data.
         * 
         * @return builder
         * 
         */
        public Builder dataAccessRoleArn(Output dataAccessRoleArn) {
            $.dataAccessRoleArn = dataAccessRoleArn;
            return this;
        }

        /**
         * @param dataAccessRoleArn The ARN for an IAM Role which allows Comprehend to read the training and testing data.
         * 
         * @return builder
         * 
         */
        public Builder dataAccessRoleArn(String dataAccessRoleArn) {
            return dataAccessRoleArn(Output.of(dataAccessRoleArn));
        }

        /**
         * @param inputDataConfig Configuration for the training and testing data.
         * See the `input_data_config` Configuration Block section below.
         * 
         * @return builder
         * 
         */
        public Builder inputDataConfig(Output inputDataConfig) {
            $.inputDataConfig = inputDataConfig;
            return this;
        }

        /**
         * @param inputDataConfig Configuration for the training and testing data.
         * See the `input_data_config` Configuration Block section below.
         * 
         * @return builder
         * 
         */
        public Builder inputDataConfig(EntityRecognizerInputDataConfigArgs inputDataConfig) {
            return inputDataConfig(Output.of(inputDataConfig));
        }

        /**
         * @param languageCode Two-letter language code for the language.
         * One of `en`, `es`, `fr`, `it`, `de`, or `pt`.
         * 
         * @return builder
         * 
         */
        public Builder languageCode(Output languageCode) {
            $.languageCode = languageCode;
            return this;
        }

        /**
         * @param languageCode Two-letter language code for the language.
         * One of `en`, `es`, `fr`, `it`, `de`, or `pt`.
         * 
         * @return builder
         * 
         */
        public Builder languageCode(String languageCode) {
            return languageCode(Output.of(languageCode));
        }

        /**
         * @param modelKmsKeyId The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
         * 
         * @return builder
         * 
         */
        public Builder modelKmsKeyId(@Nullable Output modelKmsKeyId) {
            $.modelKmsKeyId = modelKmsKeyId;
            return this;
        }

        /**
         * @param modelKmsKeyId The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
         * 
         * @return builder
         * 
         */
        public Builder modelKmsKeyId(String modelKmsKeyId) {
            return modelKmsKeyId(Output.of(modelKmsKeyId));
        }

        /**
         * @param name Name for the Entity Recognizer.
         * Has a maximum length of 63 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * 
         * The following arguments are optional:
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name Name for the Entity Recognizer.
         * Has a maximum length of 63 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * 
         * The following arguments are optional:
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param tags A map of tags to assign to the resource. If configured with a provider `default_tags` Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(@Nullable Output> tags) {
            $.tags = tags;
            return this;
        }

        /**
         * @param tags A map of tags to assign to the resource. If configured with a provider `default_tags` Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(Map tags) {
            return tags(Output.of(tags));
        }

        /**
         * @param versionName Name for the version of the Entity Recognizer.
         * Each version must have a unique name within the Entity Recognizer.
         * If omitted, the provider will assign a random, unique version name.
         * If explicitly set to `""`, no version name will be set.
         * Has a maximum length of 63 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * Conflicts with `version_name_prefix`.
         * 
         * @return builder
         * 
         */
        public Builder versionName(@Nullable Output versionName) {
            $.versionName = versionName;
            return this;
        }

        /**
         * @param versionName Name for the version of the Entity Recognizer.
         * Each version must have a unique name within the Entity Recognizer.
         * If omitted, the provider will assign a random, unique version name.
         * If explicitly set to `""`, no version name will be set.
         * Has a maximum length of 63 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * Conflicts with `version_name_prefix`.
         * 
         * @return builder
         * 
         */
        public Builder versionName(String versionName) {
            return versionName(Output.of(versionName));
        }

        /**
         * @param versionNamePrefix Creates a unique version name beginning with the specified prefix.
         * Has a maximum length of 37 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * Conflicts with `version_name`.
         * 
         * @return builder
         * 
         */
        public Builder versionNamePrefix(@Nullable Output versionNamePrefix) {
            $.versionNamePrefix = versionNamePrefix;
            return this;
        }

        /**
         * @param versionNamePrefix Creates a unique version name beginning with the specified prefix.
         * Has a maximum length of 37 characters.
         * Can contain upper- and lower-case letters, numbers, and hypen (`-`).
         * Conflicts with `version_name`.
         * 
         * @return builder
         * 
         */
        public Builder versionNamePrefix(String versionNamePrefix) {
            return versionNamePrefix(Output.of(versionNamePrefix));
        }

        /**
         * @param volumeKmsKeyId ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
         * 
         * @return builder
         * 
         */
        public Builder volumeKmsKeyId(@Nullable Output volumeKmsKeyId) {
            $.volumeKmsKeyId = volumeKmsKeyId;
            return this;
        }

        /**
         * @param volumeKmsKeyId ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
         * 
         * @return builder
         * 
         */
        public Builder volumeKmsKeyId(String volumeKmsKeyId) {
            return volumeKmsKeyId(Output.of(volumeKmsKeyId));
        }

        /**
         * @param vpcConfig Configuration parameters for VPC to contain Entity Recognizer resources.
         * See the `vpc_config` Configuration Block section below.
         * 
         * @return builder
         * 
         */
        public Builder vpcConfig(@Nullable Output vpcConfig) {
            $.vpcConfig = vpcConfig;
            return this;
        }

        /**
         * @param vpcConfig Configuration parameters for VPC to contain Entity Recognizer resources.
         * See the `vpc_config` Configuration Block section below.
         * 
         * @return builder
         * 
         */
        public Builder vpcConfig(EntityRecognizerVpcConfigArgs vpcConfig) {
            return vpcConfig(Output.of(vpcConfig));
        }

        public EntityRecognizerArgs build() {
            if ($.dataAccessRoleArn == null) {
                throw new MissingRequiredPropertyException("EntityRecognizerArgs", "dataAccessRoleArn");
            }
            if ($.inputDataConfig == null) {
                throw new MissingRequiredPropertyException("EntityRecognizerArgs", "inputDataConfig");
            }
            if ($.languageCode == null) {
                throw new MissingRequiredPropertyException("EntityRecognizerArgs", "languageCode");
            }
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy