Vocabulary class

Provides an Amazon Connect Vocabulary resource. For more information see Amazon Connect: Getting Started

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.Vocabulary("example", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "example",
    content: `Phrase\x09IPA\x09SoundsLike\x09DisplayAs
Los-Angeles\x09\x09\x09Los Angeles
F.B.I.\x09ɛ f b i aɪ\x09\x09FBI
Etienne\x09\x09eh-tee-en\x09`,
    languageCode: "en-US",
    tags: {
        Key1: "Value1",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.connect.Vocabulary("example",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="example",
    content="""Phrase\x09IPA\x09SoundsLike\x09DisplayAs
Los-Angeles\x09\x09\x09Los Angeles
F.B.I.\x09ɛ f b i aɪ\x09\x09FBI
Etienne\x09\x09eh-tee-en\x09""",
    language_code="en-US",
    tags={
        "Key1": "Value1",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Connect.Vocabulary("example", new()
    {
        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 =
        {
            { "Key1", "Value1" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewVocabulary(ctx, "example", &connect.VocabularyArgs{
			InstanceId:   pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Name:         pulumi.String("example"),
			Content:      pulumi.String("Phrase\tIPA\tSoundsLike\tDisplayAs\nLos-Angeles\t\t\tLos Angeles\nF.B.I.\tɛ f b i aɪ\t\tFBI\nEtienne\t\teh-tee-en\t"),
			LanguageCode: pulumi.String("en-US"),
			Tags: pulumi.StringMap{
				"Key1": pulumi.String("Value1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_connect_vocabulary" "example" {
  instance_id   = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
  name          = "example"
  content       = "Phrase\tIPA\tSoundsLike\tDisplayAs\nLos-Angeles\t\t\tLos Angeles\nF.B.I.\tɛ f b i aɪ\t\tFBI\nEtienne\t\teh-tee-en\t"
  language_code = "en-US"
  tags = {
    "Key1" = "Value1"
  }
}
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.ArrayList;
import java.util.Arrays;
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());

    }
}
resources:
  example:
    type: aws:connect:Vocabulary
    properties:
      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:
        Key1: Value1

Import

Using pulumi import, import Amazon Connect Vocabularies using the instanceId and vocabularyId separated by a colon (:). For example:

$ pulumi import aws:connect/vocabulary:Vocabulary example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5

Constructors

Vocabulary(String name, {VocabularyArgs? args, CustomResourceOptions? options})
Creates a new Vocabulary. name The Pulumi resource name. args Arguments used to configure this Vocabulary. The set of arguments for Vocabulary. options Resource options controlling this resource's behavior.
Vocabulary.reference(String urn)
Creates a typed reference to an existing Vocabulary resource.

Properties

arn ↔ Output<String>
ARN of the vocabulary.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
content ↔ Output<String>
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. Minimum length of 1. Maximum length of 60000.
latefinal
failureReason ↔ Output<String>
The reason why the custom vocabulary was not created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
instanceId ↔ Output<String>
Specifies the identifier of the hosting Amazon Connect Instance.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
languageCode ↔ Output<String>
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?. 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.
latefinal
lastModifiedTime ↔ Output<String>
The timestamp when the custom vocabulary was last modified.
latefinal
name ↔ Output<String>
A unique name of the custom vocabulary. Must not be more than 140 characters.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>
The current state of the custom vocabulary. Valid values are CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS.
latefinal
tags ↔ Output<Map<String, String>?>
Tags to apply to the vocabulary. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vocabularyId ↔ Output<String>
The identifier of the custom vocabulary.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {VocabularyState? state, CustomResourceOptions? options}) → Vocabulary
Gets an existing Vocabulary resource's state with the given name and id.