Class CfnPhoneNumberMixinProps.Builder
java.lang.Object
software.amazon.awscdk.mixins.preview.services.smsvoice.mixins.CfnPhoneNumberMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPhoneNumberMixinProps>
- Enclosing interface:
CfnPhoneNumberMixinProps
@Stability(Stable)
public static final class CfnPhoneNumberMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPhoneNumberMixinProps>
A builder for
CfnPhoneNumberMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.deletionProtectionEnabled(Boolean deletionProtectionEnabled) Sets the value ofCfnPhoneNumberMixinProps.getDeletionProtectionEnabled()deletionProtectionEnabled(IResolvable deletionProtectionEnabled) Sets the value ofCfnPhoneNumberMixinProps.getDeletionProtectionEnabled()isoCountryCode(String isoCountryCode) Sets the value ofCfnPhoneNumberMixinProps.getIsoCountryCode()mandatoryKeywords(IResolvable mandatoryKeywords) Sets the value ofCfnPhoneNumberMixinProps.getMandatoryKeywords()mandatoryKeywords(CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty mandatoryKeywords) Sets the value ofCfnPhoneNumberMixinProps.getMandatoryKeywords()numberCapabilities(List<String> numberCapabilities) Sets the value ofCfnPhoneNumberMixinProps.getNumberCapabilities()numberType(String numberType) Sets the value ofCfnPhoneNumberMixinProps.getNumberType()optionalKeywords(List<? extends Object> optionalKeywords) Sets the value ofCfnPhoneNumberMixinProps.getOptionalKeywords()optionalKeywords(IResolvable optionalKeywords) Sets the value ofCfnPhoneNumberMixinProps.getOptionalKeywords()optOutListName(String optOutListName) Sets the value ofCfnPhoneNumberMixinProps.getOptOutListName()selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) Sets the value ofCfnPhoneNumberMixinProps.getSelfManagedOptOutsEnabled()selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled) Sets the value ofCfnPhoneNumberMixinProps.getSelfManagedOptOutsEnabled()Sets the value ofCfnPhoneNumberMixinProps.getTags()twoWay(IResolvable twoWay) Sets the value ofCfnPhoneNumberMixinProps.getTwoWay()Sets the value ofCfnPhoneNumberMixinProps.getTwoWay()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
deletionProtectionEnabled
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled) Sets the value ofCfnPhoneNumberMixinProps.getDeletionProtectionEnabled()- Parameters:
deletionProtectionEnabled- By default this is set to false. When set to true the phone number can't be deleted.- Returns:
this
-
deletionProtectionEnabled
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled) Sets the value ofCfnPhoneNumberMixinProps.getDeletionProtectionEnabled()- Parameters:
deletionProtectionEnabled- By default this is set to false. When set to true the phone number can't be deleted.- Returns:
this
-
isoCountryCode
Sets the value ofCfnPhoneNumberMixinProps.getIsoCountryCode()- Parameters:
isoCountryCode- The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.- Returns:
this
-
mandatoryKeywords
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder mandatoryKeywords(IResolvable mandatoryKeywords) Sets the value ofCfnPhoneNumberMixinProps.getMandatoryKeywords()- Parameters:
mandatoryKeywords- Creates or updates aMandatoryKeywordconfiguration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.- Returns:
this
-
mandatoryKeywords
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder mandatoryKeywords(CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty mandatoryKeywords) Sets the value ofCfnPhoneNumberMixinProps.getMandatoryKeywords()- Parameters:
mandatoryKeywords- Creates or updates aMandatoryKeywordconfiguration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.- Returns:
this
-
numberCapabilities
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder numberCapabilities(List<String> numberCapabilities) Sets the value ofCfnPhoneNumberMixinProps.getNumberCapabilities()- Parameters:
numberCapabilities- Indicates if the phone number will be used for text messages, voice messages, or both.- Returns:
this
-
numberType
Sets the value ofCfnPhoneNumberMixinProps.getNumberType()- Parameters:
numberType- The type of phone number to request.The
ShortCodenumber type is not supported in AWS CloudFormation .- Returns:
this
-
optionalKeywords
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder optionalKeywords(IResolvable optionalKeywords) Sets the value ofCfnPhoneNumberMixinProps.getOptionalKeywords()- Parameters:
optionalKeywords- A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.- Returns:
this
-
optionalKeywords
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder optionalKeywords(List<? extends Object> optionalKeywords) Sets the value ofCfnPhoneNumberMixinProps.getOptionalKeywords()- Parameters:
optionalKeywords- A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.- Returns:
this
-
optOutListName
Sets the value ofCfnPhoneNumberMixinProps.getOptOutListName()- Parameters:
optOutListName- The name of the OptOutList associated with the phone number.- Returns:
this
-
selfManagedOptOutsEnabled
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) Sets the value ofCfnPhoneNumberMixinProps.getSelfManagedOptOutsEnabled()- Parameters:
selfManagedOptOutsEnabled- When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs- Returns:
this
-
selfManagedOptOutsEnabled
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled) Sets the value ofCfnPhoneNumberMixinProps.getSelfManagedOptOutsEnabled()- Parameters:
selfManagedOptOutsEnabled- When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs- Returns:
this
-
tags
Sets the value ofCfnPhoneNumberMixinProps.getTags()- Parameters:
tags- An array of tags (key and value pairs) to associate with the requested phone number.- Returns:
this
-
twoWay
Sets the value ofCfnPhoneNumberMixinProps.getTwoWay()- Parameters:
twoWay- Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the End User Messaging User Guide.- Returns:
this
-
twoWay
@Stability(Stable) public CfnPhoneNumberMixinProps.Builder twoWay(CfnPhoneNumberPropsMixin.TwoWayProperty twoWay) Sets the value ofCfnPhoneNumberMixinProps.getTwoWay()- Parameters:
twoWay- Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the End User Messaging User Guide.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnPhoneNumberMixinProps>- Returns:
- a new instance of
CfnPhoneNumberMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-