Class: AWSCDK::SES::CfnContactList::TopicProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/cfn_contact_list.rb

Overview

An interest group, theme, or label within a list.

Lists can have multiple topics.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_subscription_status:, display_name:, topic_name:, description: nil) ⇒ TopicProperty

Returns a new instance of TopicProperty.

Parameters:

  • default_subscription_status (String) —

    The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

  • display_name (String) —

    The name of the topic the contact will see.

  • topic_name (String) —

    The name of the topic.

  • description (String, nil) (defaults to: nil) —

    A description of what the topic is about, which the contact will see.



566
567
568
569
570
571
572
573
574
575
 
# File 'ses/cfn_contact_list.rb', line 566

def initialize(default_subscription_status:, display_name:, topic_name:, description: nil)
  @default_subscription_status = default_subscription_status
  Jsii::Type.check_type(@default_subscription_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultSubscriptionStatus")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @topic_name = topic_name
  Jsii::Type.check_type(@topic_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "topicName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#default_subscription_status ⇒ String (readonly)

The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

Returns:

  • (String)

See Also:



581
582
583
 
# File 'ses/cfn_contact_list.rb', line 581

def default_subscription_status
  @default_subscription_status
end

#description ⇒ String? (readonly)

A description of what the topic is about, which the contact will see.

Returns:

  • (String, nil)

See Also:



596
597
598
 
# File 'ses/cfn_contact_list.rb', line 596

def description
  @description
end

#display_name ⇒ String (readonly)

The name of the topic the contact will see.

Returns:

  • (String)

See Also:



586
587
588
 
# File 'ses/cfn_contact_list.rb', line 586

def display_name
  @display_name
end

#topic_name ⇒ String (readonly)

The name of the topic.

Returns:

  • (String)

See Also:



591
592
593
 
# File 'ses/cfn_contact_list.rb', line 591

def topic_name
  @topic_name
end

Class Method Details

.jsii_properties ⇒ Object 



598
599
600
601
602
603
604
605
 
# File 'ses/cfn_contact_list.rb', line 598

def self.jsii_properties
  {
    :default_subscription_status => "defaultSubscriptionStatus",
    :display_name => "displayName",
    :topic_name => "topicName",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



607
608
609
610
611
612
613
614
615
616
 
# File 'ses/cfn_contact_list.rb', line 607

def to_jsii
  result = {}
  result.merge!({
    "defaultSubscriptionStatus" => @default_subscription_status,
    "displayName" => @display_name,
    "topicName" => @topic_name,
    "description" => @description,
  })
  result.compact
end