Package software.amazon.awscdk.cfnpropertymixins.services.smsvoice

Interface CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Jsii$Proxy

Enclosing class:

CfnPhoneNumberPropsMixin

@Stability(Stable)
public static interface CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty
extends software.amazon.jsii.JsiiSerializable

The keywords HELP and STOP are mandatory keywords that each phone number must have.

For more information, see Keywords in the End User Messaging User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.smsvoice.*;
 MandatoryKeywordsProperty mandatoryKeywordsProperty = MandatoryKeywordsProperty.builder()
         .help(MandatoryKeywordProperty.builder()
                 .message("message")
                 .build())
         .stop(MandatoryKeywordProperty.builder()
                 .message("message")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Builder	A builder for CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty
static final class	CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Jsii$Proxy	An implementation for CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty

Method Summary

Modifier and Type	Method	Description
static CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Builder	builder()
default Object	getHelp()	Specifies the HELP keyword that customers use to obtain customer support for this phone number.
default Object	getStop()	Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHelp

@Stability(Stable)
@Nullable
default Object getHelp()

Specifies the HELP keyword that customers use to obtain customer support for this phone number.

For more information, see Keywords in the End User Messaging User Guide.

Returns union: either IResolvable or CfnPhoneNumberPropsMixin.MandatoryKeywordProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-help

getStop

@Stability(Stable)
@Nullable
default Object getStop()

Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number.

For more information, see Required opt-out keywords in the End User Messaging User Guide.

Returns union: either IResolvable or CfnPhoneNumberPropsMixin.MandatoryKeywordProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html#cfn-smsvoice-phonenumber-mandatorykeywords-stop

builder

@Stability(Stable)
static CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Builder builder()

Returns:

a CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty.Builder of CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty