1. Packages
  2. AWS Classic
  3. API Docs
  4. transcribe
  5. VocabularyFilter

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.transcribe.VocabularyFilter

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    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 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.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 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
    

    Create VocabularyFilter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VocabularyFilter(name: string, args: VocabularyFilterArgs, opts?: CustomResourceOptions);
    @overload
    def VocabularyFilter(resource_name: str,
                         args: VocabularyFilterArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def VocabularyFilter(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         language_code: Optional[str] = None,
                         vocabulary_filter_name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         vocabulary_filter_file_uri: Optional[str] = None,
                         words: Optional[Sequence[str]] = None)
    func NewVocabularyFilter(ctx *Context, name string, args VocabularyFilterArgs, opts ...ResourceOption) (*VocabularyFilter, error)
    public VocabularyFilter(string name, VocabularyFilterArgs args, CustomResourceOptions? opts = null)
    public VocabularyFilter(String name, VocabularyFilterArgs args)
    public VocabularyFilter(String name, VocabularyFilterArgs args, CustomResourceOptions options)
    
    type: aws:transcribe:VocabularyFilter
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VocabularyFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VocabularyFilterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VocabularyFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VocabularyFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VocabularyFilterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var vocabularyFilterResource = new Aws.Transcribe.VocabularyFilter("vocabularyFilterResource", new()
    {
        LanguageCode = "string",
        VocabularyFilterName = "string",
        Tags = 
        {
            { "string", "string" },
        },
        VocabularyFilterFileUri = "string",
        Words = new[]
        {
            "string",
        },
    });
    
    example, err := transcribe.NewVocabularyFilter(ctx, "vocabularyFilterResource", &transcribe.VocabularyFilterArgs{
    	LanguageCode:         pulumi.String("string"),
    	VocabularyFilterName: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	VocabularyFilterFileUri: pulumi.String("string"),
    	Words: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var vocabularyFilterResource = new VocabularyFilter("vocabularyFilterResource", VocabularyFilterArgs.builder()
        .languageCode("string")
        .vocabularyFilterName("string")
        .tags(Map.of("string", "string"))
        .vocabularyFilterFileUri("string")
        .words("string")
        .build());
    
    vocabulary_filter_resource = aws.transcribe.VocabularyFilter("vocabularyFilterResource",
        language_code="string",
        vocabulary_filter_name="string",
        tags={
            "string": "string",
        },
        vocabulary_filter_file_uri="string",
        words=["string"])
    
    const vocabularyFilterResource = new aws.transcribe.VocabularyFilter("vocabularyFilterResource", {
        languageCode: "string",
        vocabularyFilterName: "string",
        tags: {
            string: "string",
        },
        vocabularyFilterFileUri: "string",
        words: ["string"],
    });
    
    type: aws:transcribe:VocabularyFilter
    properties:
        languageCode: string
        tags:
            string: string
        vocabularyFilterFileUri: string
        vocabularyFilterName: string
        words:
            - string
    

    VocabularyFilter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VocabularyFilter resource accepts the following input properties:

    LanguageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    VocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    Words List<string>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    LanguageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    VocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    Words []string
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    languageCode String
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    vocabularyFilterName String

    The name of the VocabularyFilter.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vocabularyFilterFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    words List<String>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    languageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    vocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    words string[]
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    language_code str
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    vocabulary_filter_name str

    The name of the VocabularyFilter.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vocabulary_filter_file_uri str
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    words Sequence[str]
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    languageCode String
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    vocabularyFilterName String

    The name of the VocabularyFilter.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vocabularyFilterFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    words List<String>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VocabularyFilter resource produces the following output properties:

    Arn string
    ARN of the VocabularyFilter.
    DownloadUri string
    Generated download URI.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the VocabularyFilter.
    DownloadUri string
    Generated download URI.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the VocabularyFilter.
    downloadUri String
    Generated download URI.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the VocabularyFilter.
    downloadUri string
    Generated download URI.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the VocabularyFilter.
    download_uri str
    Generated download URI.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the VocabularyFilter.
    downloadUri String
    Generated download URI.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing VocabularyFilter Resource

    Get an existing VocabularyFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VocabularyFilterState, opts?: CustomResourceOptions): VocabularyFilter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            download_uri: Optional[str] = None,
            language_code: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vocabulary_filter_file_uri: Optional[str] = None,
            vocabulary_filter_name: Optional[str] = None,
            words: Optional[Sequence[str]] = None) -> VocabularyFilter
    func GetVocabularyFilter(ctx *Context, name string, id IDInput, state *VocabularyFilterState, opts ...ResourceOption) (*VocabularyFilter, error)
    public static VocabularyFilter Get(string name, Input<string> id, VocabularyFilterState? state, CustomResourceOptions? opts = null)
    public static VocabularyFilter get(String name, Output<String> id, VocabularyFilterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the VocabularyFilter.
    DownloadUri string
    Generated download URI.
    LanguageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    Tags Dictionary<string, string>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    VocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    Words List<string>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    Arn string
    ARN of the VocabularyFilter.
    DownloadUri string
    Generated download URI.
    LanguageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    Tags map[string]string
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    VocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    Words []string
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    arn String
    ARN of the VocabularyFilter.
    downloadUri String
    Generated download URI.
    languageCode String
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    tags Map<String,String>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    vocabularyFilterFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    vocabularyFilterName String

    The name of the VocabularyFilter.

    The following arguments are optional:

    words List<String>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    arn string
    ARN of the VocabularyFilter.
    downloadUri string
    Generated download URI.
    languageCode string
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    tags {[key: string]: string}
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    vocabularyFilterFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    vocabularyFilterName string

    The name of the VocabularyFilter.

    The following arguments are optional:

    words string[]
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    arn str
    ARN of the VocabularyFilter.
    download_uri str
    Generated download URI.
    language_code str
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    tags Mapping[str, str]
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    vocabulary_filter_file_uri str
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    vocabulary_filter_name str

    The name of the VocabularyFilter.

    The following arguments are optional:

    words Sequence[str]
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.
    arn String
    ARN of the VocabularyFilter.
    downloadUri String
    Generated download URI.
    languageCode String
    The language code you selected for your vocabulary filter. Refer to the supported languages page for accepted codes.
    tags Map<String>
    A map of tags to assign to the VocabularyFilter. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    vocabularyFilterFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with words argument.
    vocabularyFilterName String

    The name of the VocabularyFilter.

    The following arguments are optional:

    words List<String>
    A list of terms to include in the vocabulary. Conflicts with vocabulary_filter_file_uri argument.

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi