Class: AWSCDK::SSMContacts::CfnContactChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm_contacts/cfn_contact_channel_props.rb

Overview

Properties for defining a CfnContactChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel_address:, channel_name:, channel_type:, contact_id:, defer_activation: nil) ⇒ CfnContactChannelProps

Returns a new instance of CfnContactChannelProps.

Parameters:

  • channel_address (String) —

    The details that Incident Manager uses when trying to engage the contact channel.

  • channel_name (String) —

    The name of the contact channel.

  • channel_type (String) —

    The type of the contact channel. Incident Manager supports three contact methods:.

  • contact_id (String) —

    The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

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

    If you want to activate the channel at a later time, you can choose to defer activation.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 14

def initialize(channel_address:, channel_name:, channel_type:, contact_id:, defer_activation: nil)
  @channel_address = channel_address
  Jsii::Type.check_type(@channel_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelAddress")
  @channel_name = channel_name
  Jsii::Type.check_type(@channel_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelName")
  @channel_type = channel_type
  Jsii::Type.check_type(@channel_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelType")
  @contact_id = contact_id
  Jsii::Type.check_type(@contact_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contactId")
  @defer_activation = defer_activation
  Jsii::Type.check_type(@defer_activation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deferActivation") unless @defer_activation.nil?
end

Instance Attribute Details

#channel_address ⇒ String (readonly)

The details that Incident Manager uses when trying to engage the contact channel.

Returns:

  • (String)

See Also:



31
32
33
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 31

def channel_address
  @channel_address
end

#channel_name ⇒ String (readonly)

The name of the contact channel.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 36

def channel_name
  @channel_name
end

#channel_type ⇒ String (readonly)

The type of the contact channel. Incident Manager supports three contact methods:.

  • SMS
  • VOICE
  • EMAIL

Returns:

  • (String)

See Also:



45
46
47
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 45

def channel_type
  @channel_type
end

#contact_id ⇒ String (readonly)

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

Returns:

  • (String)

See Also:



50
51
52
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 50

def contact_id
  @contact_id
end

#defer_activation ⇒ Boolean, ... (readonly)

If you want to activate the channel at a later time, you can choose to defer activation.

Incident Manager can't engage your contact channel until it has been activated.

Returns:

See Also:



57
58
59
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 57

def defer_activation
  @defer_activation
end

Class Method Details

.jsii_properties ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 59

def self.jsii_properties
  {
    :channel_address => "channelAddress",
    :channel_name => "channelName",
    :channel_type => "channelType",
    :contact_id => "contactId",
    :defer_activation => "deferActivation",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'ssm_contacts/cfn_contact_channel_props.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "channelAddress" => @channel_address,
    "channelName" => @channel_name,
    "channelType" => @channel_type,
    "contactId" => @contact_id,
    "deferActivation" => @defer_activation,
  })
  result.compact
end