Class: AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sms_voice/cfn_phone_number.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(help:, stop:) ⇒ MandatoryKeywordsProperty

Returns a new instance of MandatoryKeywordsProperty.

Parameters:



720
721
722
723
724
725
# File 'sms_voice/cfn_phone_number.rb', line 720

def initialize(help:, stop:)
  @help = help.is_a?(Hash) ? ::AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordProperty.new(**help.transform_keys(&:to_sym)) : help
  Jsii::Type.check_type(@help, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbXN2b2ljZS5DZm5QaG9uZU51bWJlci5NYW5kYXRvcnlLZXl3b3JkUHJvcGVydHkifV19fQ==")), "help")
  @stop = stop.is_a?(Hash) ? ::AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordProperty.new(**stop.transform_keys(&:to_sym)) : stop
  Jsii::Type.check_type(@stop, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zbXN2b2ljZS5DZm5QaG9uZU51bWJlci5NYW5kYXRvcnlLZXl3b3JkUHJvcGVydHkifV19fQ==")), "stop")
end

Instance Attribute Details

#helpAWSCDK::IResolvable, AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordProperty (readonly)

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.



733
734
735
# File 'sms_voice/cfn_phone_number.rb', line 733

def help
  @help
end

#stopAWSCDK::IResolvable, AWSCDK::SMSVoice::CfnPhoneNumber::MandatoryKeywordProperty (readonly)

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.



740
741
742
# File 'sms_voice/cfn_phone_number.rb', line 740

def stop
  @stop
end

Class Method Details

.jsii_propertiesObject



742
743
744
745
746
747
# File 'sms_voice/cfn_phone_number.rb', line 742

def self.jsii_properties
  {
    :help => "help",
    :stop => "stop",
  }
end

Instance Method Details

#to_jsiiObject



749
750
751
752
753
754
755
756
# File 'sms_voice/cfn_phone_number.rb', line 749

def to_jsii
  result = {}
  result.merge!({
    "help" => @help,
    "stop" => @stop,
  })
  result.compact
end