Documentation ¶
Index ¶
- type GetVoicesArgs
- type GetVoicesOutputArgs
- type GetVoicesResult
- type GetVoicesResultOutput
- func (GetVoicesResultOutput) ElementType() reflect.Type
- func (o GetVoicesResultOutput) Engine() pulumi.StringPtrOutput
- func (o GetVoicesResultOutput) Id() pulumi.StringOutput
- func (o GetVoicesResultOutput) IncludeAdditionalLanguageCodes() pulumi.BoolPtrOutput
- func (o GetVoicesResultOutput) LanguageCode() pulumi.StringPtrOutput
- func (o GetVoicesResultOutput) ToGetVoicesResultOutput() GetVoicesResultOutput
- func (o GetVoicesResultOutput) ToGetVoicesResultOutputWithContext(ctx context.Context) GetVoicesResultOutput
- func (o GetVoicesResultOutput) Voices() GetVoicesVoiceArrayOutput
- type GetVoicesVoice
- type GetVoicesVoiceArgs
- type GetVoicesVoiceArray
- type GetVoicesVoiceArrayInput
- type GetVoicesVoiceArrayOutput
- func (GetVoicesVoiceArrayOutput) ElementType() reflect.Type
- func (o GetVoicesVoiceArrayOutput) Index(i pulumi.IntInput) GetVoicesVoiceOutput
- func (o GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutput() GetVoicesVoiceArrayOutput
- func (o GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutputWithContext(ctx context.Context) GetVoicesVoiceArrayOutput
- type GetVoicesVoiceInput
- type GetVoicesVoiceOutput
- func (o GetVoicesVoiceOutput) AdditionalLanguageCodes() pulumi.StringArrayOutput
- func (GetVoicesVoiceOutput) ElementType() reflect.Type
- func (o GetVoicesVoiceOutput) Gender() pulumi.StringOutput
- func (o GetVoicesVoiceOutput) Id() pulumi.StringOutput
- func (o GetVoicesVoiceOutput) LanguageCode() pulumi.StringOutput
- func (o GetVoicesVoiceOutput) LanguageName() pulumi.StringOutput
- func (o GetVoicesVoiceOutput) Name() pulumi.StringOutput
- func (o GetVoicesVoiceOutput) SupportedEngines() pulumi.StringArrayOutput
- func (o GetVoicesVoiceOutput) ToGetVoicesVoiceOutput() GetVoicesVoiceOutput
- func (o GetVoicesVoiceOutput) ToGetVoicesVoiceOutputWithContext(ctx context.Context) GetVoicesVoiceOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetVoicesArgs ¶
type GetVoicesArgs struct { // Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`. Engine *string `pulumi:"engine"` // Whether to return any bilingual voices that use the specified language as an additional language. IncludeAdditionalLanguageCodes *bool `pulumi:"includeAdditionalLanguageCodes"` // Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. LanguageCode *string `pulumi:"languageCode"` // List of voices with their properties. See `voices` Attribute Reference below. Voices []GetVoicesVoice `pulumi:"voices"` }
A collection of arguments for invoking getVoices.
type GetVoicesOutputArgs ¶
type GetVoicesOutputArgs struct { // Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`. Engine pulumi.StringPtrInput `pulumi:"engine"` // Whether to return any bilingual voices that use the specified language as an additional language. IncludeAdditionalLanguageCodes pulumi.BoolPtrInput `pulumi:"includeAdditionalLanguageCodes"` // Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. LanguageCode pulumi.StringPtrInput `pulumi:"languageCode"` // List of voices with their properties. See `voices` Attribute Reference below. Voices GetVoicesVoiceArrayInput `pulumi:"voices"` }
A collection of arguments for invoking getVoices.
func (GetVoicesOutputArgs) ElementType ¶
func (GetVoicesOutputArgs) ElementType() reflect.Type
type GetVoicesResult ¶
type GetVoicesResult struct { Engine *string `pulumi:"engine"` // Amazon Polly assigned voice ID. Id string `pulumi:"id"` IncludeAdditionalLanguageCodes *bool `pulumi:"includeAdditionalLanguageCodes"` // Language code of the voice. LanguageCode *string `pulumi:"languageCode"` // List of voices with their properties. See `voices` Attribute Reference below. Voices []GetVoicesVoice `pulumi:"voices"` }
A collection of values returned by getVoices.
func GetVoices ¶
func GetVoices(ctx *pulumi.Context, args *GetVoicesArgs, opts ...pulumi.InvokeOption) (*GetVoicesResult, error)
Data source for managing an AWS Polly Voices.
## Example Usage ### Basic Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/polly" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := polly.GetVoices(ctx, nil, nil) if err != nil { return err } return nil }) }
``` ### With Language Code
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/polly" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := polly.GetVoices(ctx, &polly.GetVoicesArgs{ LanguageCode: pulumi.StringRef("en-GB"), }, nil) if err != nil { return err } return nil }) }
```
type GetVoicesResultOutput ¶
type GetVoicesResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getVoices.
func GetVoicesOutput ¶
func GetVoicesOutput(ctx *pulumi.Context, args GetVoicesOutputArgs, opts ...pulumi.InvokeOption) GetVoicesResultOutput
func (GetVoicesResultOutput) ElementType ¶
func (GetVoicesResultOutput) ElementType() reflect.Type
func (GetVoicesResultOutput) Engine ¶
func (o GetVoicesResultOutput) Engine() pulumi.StringPtrOutput
func (GetVoicesResultOutput) Id ¶
func (o GetVoicesResultOutput) Id() pulumi.StringOutput
Amazon Polly assigned voice ID.
func (GetVoicesResultOutput) IncludeAdditionalLanguageCodes ¶
func (o GetVoicesResultOutput) IncludeAdditionalLanguageCodes() pulumi.BoolPtrOutput
func (GetVoicesResultOutput) LanguageCode ¶
func (o GetVoicesResultOutput) LanguageCode() pulumi.StringPtrOutput
Language code of the voice.
func (GetVoicesResultOutput) ToGetVoicesResultOutput ¶
func (o GetVoicesResultOutput) ToGetVoicesResultOutput() GetVoicesResultOutput
func (GetVoicesResultOutput) ToGetVoicesResultOutputWithContext ¶
func (o GetVoicesResultOutput) ToGetVoicesResultOutputWithContext(ctx context.Context) GetVoicesResultOutput
func (GetVoicesResultOutput) Voices ¶
func (o GetVoicesResultOutput) Voices() GetVoicesVoiceArrayOutput
List of voices with their properties. See `voices` Attribute Reference below.
type GetVoicesVoice ¶
type GetVoicesVoice struct { // Additional codes for languages available for the specified voice in addition to its default language. AdditionalLanguageCodes []string `pulumi:"additionalLanguageCodes"` // Gender of the voice. Gender string `pulumi:"gender"` // Amazon Polly assigned voice ID. Id string `pulumi:"id"` // Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. LanguageCode string `pulumi:"languageCode"` // Human readable name of the language in English. LanguageName string `pulumi:"languageName"` // Name of the voice. Name string `pulumi:"name"` // Specifies which engines are supported by a given voice. SupportedEngines []string `pulumi:"supportedEngines"` }
type GetVoicesVoiceArgs ¶
type GetVoicesVoiceArgs struct { // Additional codes for languages available for the specified voice in addition to its default language. AdditionalLanguageCodes pulumi.StringArrayInput `pulumi:"additionalLanguageCodes"` // Gender of the voice. Gender pulumi.StringInput `pulumi:"gender"` // Amazon Polly assigned voice ID. Id pulumi.StringInput `pulumi:"id"` // Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. LanguageCode pulumi.StringInput `pulumi:"languageCode"` // Human readable name of the language in English. LanguageName pulumi.StringInput `pulumi:"languageName"` // Name of the voice. Name pulumi.StringInput `pulumi:"name"` // Specifies which engines are supported by a given voice. SupportedEngines pulumi.StringArrayInput `pulumi:"supportedEngines"` }
func (GetVoicesVoiceArgs) ElementType ¶
func (GetVoicesVoiceArgs) ElementType() reflect.Type
func (GetVoicesVoiceArgs) ToGetVoicesVoiceOutput ¶
func (i GetVoicesVoiceArgs) ToGetVoicesVoiceOutput() GetVoicesVoiceOutput
func (GetVoicesVoiceArgs) ToGetVoicesVoiceOutputWithContext ¶
func (i GetVoicesVoiceArgs) ToGetVoicesVoiceOutputWithContext(ctx context.Context) GetVoicesVoiceOutput
type GetVoicesVoiceArray ¶
type GetVoicesVoiceArray []GetVoicesVoiceInput
func (GetVoicesVoiceArray) ElementType ¶
func (GetVoicesVoiceArray) ElementType() reflect.Type
func (GetVoicesVoiceArray) ToGetVoicesVoiceArrayOutput ¶
func (i GetVoicesVoiceArray) ToGetVoicesVoiceArrayOutput() GetVoicesVoiceArrayOutput
func (GetVoicesVoiceArray) ToGetVoicesVoiceArrayOutputWithContext ¶
func (i GetVoicesVoiceArray) ToGetVoicesVoiceArrayOutputWithContext(ctx context.Context) GetVoicesVoiceArrayOutput
type GetVoicesVoiceArrayInput ¶
type GetVoicesVoiceArrayInput interface { pulumi.Input ToGetVoicesVoiceArrayOutput() GetVoicesVoiceArrayOutput ToGetVoicesVoiceArrayOutputWithContext(context.Context) GetVoicesVoiceArrayOutput }
GetVoicesVoiceArrayInput is an input type that accepts GetVoicesVoiceArray and GetVoicesVoiceArrayOutput values. You can construct a concrete instance of `GetVoicesVoiceArrayInput` via:
GetVoicesVoiceArray{ GetVoicesVoiceArgs{...} }
type GetVoicesVoiceArrayOutput ¶
type GetVoicesVoiceArrayOutput struct{ *pulumi.OutputState }
func (GetVoicesVoiceArrayOutput) ElementType ¶
func (GetVoicesVoiceArrayOutput) ElementType() reflect.Type
func (GetVoicesVoiceArrayOutput) Index ¶
func (o GetVoicesVoiceArrayOutput) Index(i pulumi.IntInput) GetVoicesVoiceOutput
func (GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutput ¶
func (o GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutput() GetVoicesVoiceArrayOutput
func (GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutputWithContext ¶
func (o GetVoicesVoiceArrayOutput) ToGetVoicesVoiceArrayOutputWithContext(ctx context.Context) GetVoicesVoiceArrayOutput
type GetVoicesVoiceInput ¶
type GetVoicesVoiceInput interface { pulumi.Input ToGetVoicesVoiceOutput() GetVoicesVoiceOutput ToGetVoicesVoiceOutputWithContext(context.Context) GetVoicesVoiceOutput }
GetVoicesVoiceInput is an input type that accepts GetVoicesVoiceArgs and GetVoicesVoiceOutput values. You can construct a concrete instance of `GetVoicesVoiceInput` via:
GetVoicesVoiceArgs{...}
type GetVoicesVoiceOutput ¶
type GetVoicesVoiceOutput struct{ *pulumi.OutputState }
func (GetVoicesVoiceOutput) AdditionalLanguageCodes ¶
func (o GetVoicesVoiceOutput) AdditionalLanguageCodes() pulumi.StringArrayOutput
Additional codes for languages available for the specified voice in addition to its default language.
func (GetVoicesVoiceOutput) ElementType ¶
func (GetVoicesVoiceOutput) ElementType() reflect.Type
func (GetVoicesVoiceOutput) Gender ¶
func (o GetVoicesVoiceOutput) Gender() pulumi.StringOutput
Gender of the voice.
func (GetVoicesVoiceOutput) Id ¶
func (o GetVoicesVoiceOutput) Id() pulumi.StringOutput
Amazon Polly assigned voice ID.
func (GetVoicesVoiceOutput) LanguageCode ¶
func (o GetVoicesVoiceOutput) LanguageCode() pulumi.StringOutput
Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned.
func (GetVoicesVoiceOutput) LanguageName ¶
func (o GetVoicesVoiceOutput) LanguageName() pulumi.StringOutput
Human readable name of the language in English.
func (GetVoicesVoiceOutput) Name ¶
func (o GetVoicesVoiceOutput) Name() pulumi.StringOutput
Name of the voice.
func (GetVoicesVoiceOutput) SupportedEngines ¶
func (o GetVoicesVoiceOutput) SupportedEngines() pulumi.StringArrayOutput
Specifies which engines are supported by a given voice.
func (GetVoicesVoiceOutput) ToGetVoicesVoiceOutput ¶
func (o GetVoicesVoiceOutput) ToGetVoicesVoiceOutput() GetVoicesVoiceOutput
func (GetVoicesVoiceOutput) ToGetVoicesVoiceOutputWithContext ¶
func (o GetVoicesVoiceOutput) ToGetVoicesVoiceOutputWithContext(ctx context.Context) GetVoicesVoiceOutput