com.pulumi.aws.connect.Vocabulary Maven / Gradle / Ivy
// *** 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.connect;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.connect.VocabularyArgs;
import com.pulumi.aws.connect.inputs.VocabularyState;
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.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides an Amazon Connect Vocabulary resource. For more information see
* [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.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.connect.Vocabulary;
* import com.pulumi.aws.connect.VocabularyArgs;
* 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 Vocabulary("example", VocabularyArgs.builder()
* .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
* .name("example")
* .content("""
* Phrase IPA SoundsLike DisplayAs
* Los-Angeles Los Angeles
* F.B.I. ɛ f b i aɪ FBI
* Etienne eh-tee-en """)
* .languageCode("en-US")
* .tags(Map.of("Key1", "Value1"))
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import Amazon Connect Vocabularies using the `instance_id` and `vocabulary_id` separated by a colon (`:`). For example:
*
* ```sh
* $ pulumi import aws:connect/vocabulary:Vocabulary example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
* ```
*
*/
@ResourceType(type="aws:connect/vocabulary:Vocabulary")
public class Vocabulary extends com.pulumi.resources.CustomResource {
/**
* The Amazon Resource Name (ARN) of the vocabulary.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The Amazon Resource Name (ARN) of the vocabulary.
*
*/
public Output arn() {
return this.arn;
}
/**
* The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see [Create a custom vocabulary using a table](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). Minimum length of `1`. Maximum length of `60000`.
*
*/
@Export(name="content", refs={String.class}, tree="[0]")
private Output content;
/**
* @return The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see [Create a custom vocabulary using a table](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). Minimum length of `1`. Maximum length of `60000`.
*
*/
public Output content() {
return this.content;
}
/**
* The reason why the custom vocabulary was not created.
*
*/
@Export(name="failureReason", refs={String.class}, tree="[0]")
private Output failureReason;
/**
* @return The reason why the custom vocabulary was not created.
*
*/
public Output failureReason() {
return this.failureReason;
}
/**
* Specifies the identifier of the hosting Amazon Connect Instance.
*
*/
@Export(name="instanceId", refs={String.class}, tree="[0]")
private Output instanceId;
/**
* @return Specifies the identifier of the hosting Amazon Connect Instance.
*
*/
public Output instanceId() {
return this.instanceId;
}
/**
* The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html). Valid Values are `ar-AE`, `de-CH`, `de-DE`, `en-AB`, `en-AU`, `en-GB`, `en-IE`, `en-IN`, `en-US`, `en-WL`, `es-ES`, `es-US`, `fr-CA`, `fr-FR`, `hi-IN`, `it-IT`, `ja-JP`, `ko-KR`, `pt-BR`, `pt-PT`, `zh-CN`.
*
*/
@Export(name="languageCode", refs={String.class}, tree="[0]")
private Output languageCode;
/**
* @return The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html). Valid Values are `ar-AE`, `de-CH`, `de-DE`, `en-AB`, `en-AU`, `en-GB`, `en-IE`, `en-IN`, `en-US`, `en-WL`, `es-ES`, `es-US`, `fr-CA`, `fr-FR`, `hi-IN`, `it-IT`, `ja-JP`, `ko-KR`, `pt-BR`, `pt-PT`, `zh-CN`.
*
*/
public Output languageCode() {
return this.languageCode;
}
/**
* The timestamp when the custom vocabulary was last modified.
*
*/
@Export(name="lastModifiedTime", refs={String.class}, tree="[0]")
private Output lastModifiedTime;
/**
* @return The timestamp when the custom vocabulary was last modified.
*
*/
public Output lastModifiedTime() {
return this.lastModifiedTime;
}
/**
* A unique name of the custom vocabulary. Must not be more than 140 characters.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return A unique name of the custom vocabulary. Must not be more than 140 characters.
*
*/
public Output name() {
return this.name;
}
/**
* The current state of the custom vocabulary. Valid values are `CREATION_IN_PROGRESS`, `ACTIVE`, `CREATION_FAILED`, `DELETE_IN_PROGRESS`.
*
*/
@Export(name="state", refs={String.class}, tree="[0]")
private Output state;
/**
* @return The current state of the custom vocabulary. Valid values are `CREATION_IN_PROGRESS`, `ACTIVE`, `CREATION_FAILED`, `DELETE_IN_PROGRESS`.
*
*/
public Output state() {
return this.state;
}
/**
* Tags to apply to the vocabulary. If configured with a provider
* `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Tags to apply to the vocabulary. If configured with a provider
* `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @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;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
* The identifier of the custom vocabulary.
*
*/
@Export(name="vocabularyId", refs={String.class}, tree="[0]")
private Output vocabularyId;
/**
* @return The identifier of the custom vocabulary.
*
*/
public Output vocabularyId() {
return this.vocabularyId;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Vocabulary(java.lang.String name) {
this(name, VocabularyArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Vocabulary(java.lang.String name, VocabularyArgs 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 Vocabulary(java.lang.String name, VocabularyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:connect/vocabulary:Vocabulary", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Vocabulary(java.lang.String name, Output id, @Nullable VocabularyState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:connect/vocabulary:Vocabulary", name, state, makeResourceOptions(options, id), false);
}
private static VocabularyArgs makeArgs(VocabularyArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? VocabularyArgs.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 Vocabulary get(java.lang.String name, Output id, @Nullable VocabularyState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Vocabulary(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy