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

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.MedicalVocabulary

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 MedicalVocabulary.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.s3.BucketV2("example", {
        bucket: "example-medical-vocab-123",
        forceDestroy: true,
    });
    const object = new aws.s3.BucketObjectv2("object", {
        bucket: example.id,
        key: "transcribe/test1.txt",
        source: new pulumi.asset.FileAsset("test.txt"),
    });
    const exampleMedicalVocabulary = new aws.transcribe.MedicalVocabulary("example", {
        vocabularyName: "example",
        languageCode: "en-US",
        vocabularyFileUri: pulumi.interpolate`s3://${example.id}/${object.key}`,
        tags: {
            tag1: "value1",
            tag2: "value3",
        },
    }, {
        dependsOn: [object],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3.BucketV2("example",
        bucket="example-medical-vocab-123",
        force_destroy=True)
    object = aws.s3.BucketObjectv2("object",
        bucket=example.id,
        key="transcribe/test1.txt",
        source=pulumi.FileAsset("test.txt"))
    example_medical_vocabulary = aws.transcribe.MedicalVocabulary("example",
        vocabulary_name="example",
        language_code="en-US",
        vocabulary_file_uri=pulumi.Output.all(example.id, object.key).apply(lambda id, key: f"s3://{id}/{key}"),
        tags={
            "tag1": "value1",
            "tag2": "value3",
        },
        opts=pulumi.ResourceOptions(depends_on=[object]))
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"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 {
    		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
    			Bucket:       pulumi.String("example-medical-vocab-123"),
    			ForceDestroy: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		object, err := s3.NewBucketObjectv2(ctx, "object", &s3.BucketObjectv2Args{
    			Bucket: example.ID(),
    			Key:    pulumi.String("transcribe/test1.txt"),
    			Source: pulumi.NewFileAsset("test.txt"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = transcribe.NewMedicalVocabulary(ctx, "example", &transcribe.MedicalVocabularyArgs{
    			VocabularyName: pulumi.String("example"),
    			LanguageCode:   pulumi.String("en-US"),
    			VocabularyFileUri: pulumi.All(example.ID(), object.Key).ApplyT(func(_args []interface{}) (string, error) {
    				id := _args[0].(string)
    				key := _args[1].(string)
    				return fmt.Sprintf("s3://%v/%v", id, key), nil
    			}).(pulumi.StringOutput),
    			Tags: pulumi.StringMap{
    				"tag1": pulumi.String("value1"),
    				"tag2": pulumi.String("value3"),
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			object,
    		}))
    		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.S3.BucketV2("example", new()
        {
            Bucket = "example-medical-vocab-123",
            ForceDestroy = true,
        });
    
        var @object = new Aws.S3.BucketObjectv2("object", new()
        {
            Bucket = example.Id,
            Key = "transcribe/test1.txt",
            Source = new FileAsset("test.txt"),
        });
    
        var exampleMedicalVocabulary = new Aws.Transcribe.MedicalVocabulary("example", new()
        {
            VocabularyName = "example",
            LanguageCode = "en-US",
            VocabularyFileUri = Output.Tuple(example.Id, @object.Key).Apply(values =>
            {
                var id = values.Item1;
                var key = values.Item2;
                return $"s3://{id}/{key}";
            }),
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value3" },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                @object,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketV2;
    import com.pulumi.aws.s3.BucketV2Args;
    import com.pulumi.aws.s3.BucketObjectv2;
    import com.pulumi.aws.s3.BucketObjectv2Args;
    import com.pulumi.aws.transcribe.MedicalVocabulary;
    import com.pulumi.aws.transcribe.MedicalVocabularyArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import com.pulumi.asset.FileAsset;
    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 BucketV2("example", BucketV2Args.builder()
                .bucket("example-medical-vocab-123")
                .forceDestroy(true)
                .build());
    
            var object = new BucketObjectv2("object", BucketObjectv2Args.builder()
                .bucket(example.id())
                .key("transcribe/test1.txt")
                .source(new FileAsset("test.txt"))
                .build());
    
            var exampleMedicalVocabulary = new MedicalVocabulary("exampleMedicalVocabulary", MedicalVocabularyArgs.builder()
                .vocabularyName("example")
                .languageCode("en-US")
                .vocabularyFileUri(Output.tuple(example.id(), object.key()).applyValue(values -> {
                    var id = values.t1;
                    var key = values.t2;
                    return String.format("s3://%s/%s", id,key);
                }))
                .tags(Map.ofEntries(
                    Map.entry("tag1", "value1"),
                    Map.entry("tag2", "value3")
                ))
                .build(), CustomResourceOptions.builder()
                    .dependsOn(object)
                    .build());
    
        }
    }
    
    resources:
      example:
        type: aws:s3:BucketV2
        properties:
          bucket: example-medical-vocab-123
          forceDestroy: true
      object:
        type: aws:s3:BucketObjectv2
        properties:
          bucket: ${example.id}
          key: transcribe/test1.txt
          source:
            fn::FileAsset: test.txt
      exampleMedicalVocabulary:
        type: aws:transcribe:MedicalVocabulary
        name: example
        properties:
          vocabularyName: example
          languageCode: en-US
          vocabularyFileUri: s3://${example.id}/${object.key}
          tags:
            tag1: value1
            tag2: value3
        options:
          dependson:
            - ${object}
    

    Create MedicalVocabulary Resource

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

    Constructor syntax

    new MedicalVocabulary(name: string, args: MedicalVocabularyArgs, opts?: CustomResourceOptions);
    @overload
    def MedicalVocabulary(resource_name: str,
                          args: MedicalVocabularyArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def MedicalVocabulary(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          language_code: Optional[str] = None,
                          vocabulary_file_uri: Optional[str] = None,
                          vocabulary_name: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewMedicalVocabulary(ctx *Context, name string, args MedicalVocabularyArgs, opts ...ResourceOption) (*MedicalVocabulary, error)
    public MedicalVocabulary(string name, MedicalVocabularyArgs args, CustomResourceOptions? opts = null)
    public MedicalVocabulary(String name, MedicalVocabularyArgs args)
    public MedicalVocabulary(String name, MedicalVocabularyArgs args, CustomResourceOptions options)
    
    type: aws:transcribe:MedicalVocabulary
    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 MedicalVocabularyArgs
    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 MedicalVocabularyArgs
    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 MedicalVocabularyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MedicalVocabularyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MedicalVocabularyArgs
    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 medicalVocabularyResource = new Aws.Transcribe.MedicalVocabulary("medicalVocabularyResource", new()
    {
        LanguageCode = "string",
        VocabularyFileUri = "string",
        VocabularyName = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := transcribe.NewMedicalVocabulary(ctx, "medicalVocabularyResource", &transcribe.MedicalVocabularyArgs{
    	LanguageCode:      pulumi.String("string"),
    	VocabularyFileUri: pulumi.String("string"),
    	VocabularyName:    pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var medicalVocabularyResource = new MedicalVocabulary("medicalVocabularyResource", MedicalVocabularyArgs.builder()
        .languageCode("string")
        .vocabularyFileUri("string")
        .vocabularyName("string")
        .tags(Map.of("string", "string"))
        .build());
    
    medical_vocabulary_resource = aws.transcribe.MedicalVocabulary("medicalVocabularyResource",
        language_code="string",
        vocabulary_file_uri="string",
        vocabulary_name="string",
        tags={
            "string": "string",
        })
    
    const medicalVocabularyResource = new aws.transcribe.MedicalVocabulary("medicalVocabularyResource", {
        languageCode: "string",
        vocabularyFileUri: "string",
        vocabularyName: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:transcribe:MedicalVocabulary
    properties:
        languageCode: string
        tags:
            string: string
        vocabularyFileUri: string
        vocabularyName: string
    

    MedicalVocabulary 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 MedicalVocabulary resource accepts the following input properties:

    LanguageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    VocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    VocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    LanguageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    VocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    VocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    languageCode String
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    vocabularyFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName String

    The name of the Medical Vocabulary.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    languageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    vocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    language_code str
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    vocabulary_file_uri str
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabulary_name str

    The name of the Medical Vocabulary.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    languageCode String
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    vocabularyFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName String

    The name of the Medical Vocabulary.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the MedicalVocabulary. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the MedicalVocabulary.
    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 MedicalVocabulary.
    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 MedicalVocabulary.
    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 MedicalVocabulary.
    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 MedicalVocabulary.
    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 MedicalVocabulary.
    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 MedicalVocabulary Resource

    Get an existing MedicalVocabulary 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?: MedicalVocabularyState, opts?: CustomResourceOptions): MedicalVocabulary
    @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_file_uri: Optional[str] = None,
            vocabulary_name: Optional[str] = None) -> MedicalVocabulary
    func GetMedicalVocabulary(ctx *Context, name string, id IDInput, state *MedicalVocabularyState, opts ...ResourceOption) (*MedicalVocabulary, error)
    public static MedicalVocabulary Get(string name, Input<string> id, MedicalVocabularyState? state, CustomResourceOptions? opts = null)
    public static MedicalVocabulary get(String name, Output<String> id, MedicalVocabularyState 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 MedicalVocabulary.
    DownloadUri string
    Generated download URI.
    LanguageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    Tags Dictionary<string, string>
    A map of tags to assign to the MedicalVocabulary. 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.

    VocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    VocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    Arn string
    ARN of the MedicalVocabulary.
    DownloadUri string
    Generated download URI.
    LanguageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    Tags map[string]string
    A map of tags to assign to the MedicalVocabulary. 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.

    VocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    VocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    arn String
    ARN of the MedicalVocabulary.
    downloadUri String
    Generated download URI.
    languageCode String
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    tags Map<String,String>
    A map of tags to assign to the MedicalVocabulary. 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.

    vocabularyFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName String

    The name of the Medical Vocabulary.

    The following arguments are optional:

    arn string
    ARN of the MedicalVocabulary.
    downloadUri string
    Generated download URI.
    languageCode string
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    tags {[key: string]: string}
    A map of tags to assign to the MedicalVocabulary. 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.

    vocabularyFileUri string
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName string

    The name of the Medical Vocabulary.

    The following arguments are optional:

    arn str
    ARN of the MedicalVocabulary.
    download_uri str
    Generated download URI.
    language_code str
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    tags Mapping[str, str]
    A map of tags to assign to the MedicalVocabulary. 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_file_uri str
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabulary_name str

    The name of the Medical Vocabulary.

    The following arguments are optional:

    arn String
    ARN of the MedicalVocabulary.
    downloadUri String
    Generated download URI.
    languageCode String
    The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
    tags Map<String>
    A map of tags to assign to the MedicalVocabulary. 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.

    vocabularyFileUri String
    The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
    vocabularyName String

    The name of the Medical Vocabulary.

    The following arguments are optional:

    Import

    Using pulumi import, import Transcribe MedicalVocabulary using the vocabulary_name. For example:

    $ pulumi import aws:transcribe/medicalVocabulary:MedicalVocabulary 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