Class CfnVoiceChannel
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.pinpoint.CfnVoiceChannel
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:00.887Z")
@Stability(Stable)
public class CfnVoiceChannel
extends CfnResource
implements IInspectable
A CloudFormation
AWS::Pinpoint::VoiceChannel
.
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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnVoiceChannel
(Construct scope, String id, CfnVoiceChannelProps props) Create a newAWS::Pinpoint::VoiceChannel
.protected
CfnVoiceChannel
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVoiceChannel
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe unique identifier for the Amazon Pinpoint application that the voice channel applies to.Specifies whether to enable the voice channel for the application.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setApplicationId
(String value) The unique identifier for the Amazon Pinpoint application that the voice channel applies to.void
setEnabled
(Boolean value) Specifies whether to enable the voice channel for the application.void
setEnabled
(IResolvable value) Specifies whether to enable the voice channel for the application.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 Construct scope, @NotNull String id, @NotNull CfnVoiceChannelProps props) Create a newAWS::Pinpoint::VoiceChannel
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApplicationId
The unique identifier for the Amazon Pinpoint application that the voice channel applies to. -
setApplicationId
The unique identifier for the Amazon Pinpoint application that the voice channel applies to. -
getEnabled
Specifies whether to enable the voice channel for the application. -
setEnabled
Specifies whether to enable the voice channel for the application. -
setEnabled
Specifies whether to enable the voice channel for the application.
-