VocabularyFilter class

Resource for managing an AWS Transcribe VocabularyFilter.

Example Usage

Basic Usage

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

const example = new aws.transcribe.VocabularyFilter("example", {
    vocabularyFilterName: "example",
    languageCode: "en-US",
    words: [
        "cars",
        "bucket",
    ],
    tags: {
        tag1: "value1",
        tag2: "value3",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.transcribe.VocabularyFilter("example",
    vocabulary_filter_name="example",
    language_code="en-US",
    words=[
        "cars",
        "bucket",
    ],
    tags={
        "tag1": "value1",
        "tag2": "value3",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Transcribe.VocabularyFilter("example", new()
    {
        VocabularyFilterName = "example",
        LanguageCode = "en-US",
        Words = new[]
        {
            "cars",
            "bucket",
        },
        Tags =
        {
            { "tag1", "value1" },
            { "tag2", "value3" },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transcribe.NewVocabularyFilter(ctx, "example", &transcribe.VocabularyFilterArgs{
			VocabularyFilterName: pulumi.String("example"),
			LanguageCode:         pulumi.String("en-US"),
			Words: pulumi.StringArray{
				pulumi.String("cars"),
				pulumi.String("bucket"),
			},
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value3"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transcribe_vocabularyfilter" "example" {
  vocabulary_filter_name = "example"
  language_code          = "en-US"
  words                  = ["cars", "bucket"]
  tags = {
    "tag1" = "value1"
    "tag2" = "value3"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transcribe.VocabularyFilter;
import com.pulumi.aws.transcribe.VocabularyFilterArgs;
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 VocabularyFilter("example", VocabularyFilterArgs.builder()
            .vocabularyFilterName("example")
            .languageCode("en-US")
            .words(
                "cars",
                "bucket")
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value3")
            ))
            .build());

    }
}
resources:
  example:
    type: aws:transcribe:VocabularyFilter
    properties:
      vocabularyFilterName: example
      languageCode: en-US
      words:
        - cars
        - bucket
      tags:
        tag1: value1
        tag2: value3

Import

Using pulumi import, import Transcribe VocabularyFilter using the vocabularyFilterName. For example:

$ pulumi import aws:transcribe/vocabularyFilter:VocabularyFilter example example-name

Constructors

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

Properties

arn ↔ Output<String>
ARN of the VocabularyFilter.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
downloadUri ↔ Output<String>
Generated download URI.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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>
Language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
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
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the VocabularyFilter. 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>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vocabularyFilterFileUri ↔ Output<String?>
Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
latefinal
vocabularyFilterName ↔ Output<String>
Name of the VocabularyFilter.
latefinal
words ↔ Output<List<String>?>
List of terms to include in the vocabulary. Conflicts with vocabularyFilterFileUri argument.
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, {VocabularyFilterState? state, CustomResourceOptions? options}) → VocabularyFilter
Gets an existing VocabularyFilter resource's state with the given name and id.