Class: AWSCDK::SMSVoice::CfnSenderIdProps

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

Overview

Properties for defining a CfnSenderId.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(iso_country_code:, sender_id:, deletion_protection_enabled: nil, tags: nil) ⇒ CfnSenderIdProps

Returns a new instance of CfnSenderIdProps.

Parameters:

  • iso_country_code (String) —

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • sender_id (String) —

    The sender ID string to request.

  • deletion_protection_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    By default this is set to false.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of tags (key and value pairs) to associate with the sender ID.



13
14
15
16
17
18
19
20
21
22
 
# File 'sms_voice/cfn_sender_id_props.rb', line 13

def initialize(iso_country_code:, sender_id:, deletion_protection_enabled: nil, tags: nil)
  @iso_country_code = iso_country_code
  Jsii::Type.check_type(@iso_country_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "isoCountryCode")
  @sender_id = sender_id
  Jsii::Type.check_type(@sender_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "senderId")
  @deletion_protection_enabled = deletion_protection_enabled
  Jsii::Type.check_type(@deletion_protection_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtectionEnabled") unless @deletion_protection_enabled.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#deletion_protection_enabled ⇒ Boolean, ... (readonly)

By default this is set to false.

When set to true the sender ID can't be deleted.

Returns:

See Also:



40
41
42
 
# File 'sms_voice/cfn_sender_id_props.rb', line 40

def deletion_protection_enabled
  @deletion_protection_enabled
end

#iso_country_code ⇒ String (readonly)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'sms_voice/cfn_sender_id_props.rb', line 28

def iso_country_code
  @iso_country_code
end

#sender_id ⇒ String (readonly)

The sender ID string to request.

Returns:

  • (String)

See Also:



33
34
35
 
# File 'sms_voice/cfn_sender_id_props.rb', line 33

def sender_id
  @sender_id
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of tags (key and value pairs) to associate with the sender ID.

Returns:

See Also:



45
46
47
 
# File 'sms_voice/cfn_sender_id_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'sms_voice/cfn_sender_id_props.rb', line 47

def self.jsii_properties
  {
    :iso_country_code => "isoCountryCode",
    :sender_id => "senderId",
    :deletion_protection_enabled => "deletionProtectionEnabled",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'sms_voice/cfn_sender_id_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "isoCountryCode" => @iso_country_code,
    "senderId" => @sender_id,
    "deletionProtectionEnabled" => @deletion_protection_enabled,
    "tags" => @tags,
  })
  result.compact
end