A channel is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.
The VoiceChannel resource represents the status and other information about the voice channel for an application.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Pinpoint::VoiceChannel",
"Properties" : {
"ApplicationId" : String,
"Enabled" : Boolean
}
}
YAML
Type: AWS::Pinpoint::VoiceChannel
Properties:
ApplicationId: String
Enabled: Boolean
Properties
ApplicationId-
The unique identifier for the Amazon Pinpoint application that the voice channel applies to.
Required: Yes
Type: String
Update requires: Replacement
Enabled-
Specifies whether to enable the voice channel for the application.
Required: No
Type: Boolean
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier (ApplicationId) for
the Amazon Pinpoint application that the channel is associated with.
For more information about using the Ref function, see Ref.
Fn::GetAtt
Id-
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
