Package software.amazon.awscdk.services.pinpoint

Class CfnVoiceChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.pinpoint.CfnVoiceChannel
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IVoiceChannelRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:10.933Z") @Stability(Stable) public class CfnVoiceChannel extends CfnResource implements IInspectable, IVoiceChannelRef
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnVoiceChannel cfnVoiceChannel = CfnVoiceChannel.Builder.create(this, "MyCfnVoiceChannel")
         .applicationId("applicationId")
         // the properties below are optional
         .enabled(false)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnVoiceChannel

      protected CfnVoiceChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVoiceChannel

      protected CfnVoiceChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVoiceChannel

      @Stability(Stable) public CfnVoiceChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVoiceChannelProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      (Deprecated) An identifier for the voice channel.

      This property is retained only for backward compatibility.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getVoiceChannelRef

      @Stability(Stable) @NotNull public VoiceChannelReference getVoiceChannelRef()
      A reference to a VoiceChannel resource.
      Specified by:
      getVoiceChannelRef in interface IVoiceChannelRef

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier for the Amazon Pinpoint application that the voice channel applies to.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application that the voice channel applies to.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      Specifies whether to enable the voice channel for the application.

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether to enable the voice channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether to enable the voice channel for the application.