Class: AWSCDK::SSMContacts::CfnContactProps

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

Overview

Properties for defining a CfnContact.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(_alias:, display_name:, type:, plan: nil, tags: nil) ⇒ CfnContactProps

Returns a new instance of CfnContactProps.

Parameters:



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

def initialize(_alias:, display_name:, type:, plan: nil, tags: nil)
  @_alias = _alias
  Jsii::Type.check_type(@_alias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alias")
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @plan = plan
  Jsii::Type.check_type(@plan, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtY29udGFjdHMuQ2ZuQ29udGFjdC5TdGFnZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "plan") unless @plan.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

#_alias ⇒ String (readonly)

The unique and identifiable alias of the contact or escalation plan.

Returns:

  • (String)

See Also:



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

def _alias
  @_alias
end

#display_name ⇒ String (readonly)

The full name of the contact or escalation plan.

Returns:

  • (String)

See Also:



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

def display_name
  @display_name
end

#plan ⇒ AWSCDK::IResolvable, ... (readonly)

A list of stages.

A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Returns:

See Also:



52
53
54
 
# File 'ssm_contacts/cfn_contact_props.rb', line 52

def plan
  @plan
end

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

Returns:

See Also:



55
56
57
 
# File 'ssm_contacts/cfn_contact_props.rb', line 55

def tags
  @tags
end

#type ⇒ String (readonly)

The type of contact.

  • PERSONAL : A single, individual contact.
  • ESCALATION : An escalation plan.
  • ONCALL_SCHEDULE : An on-call schedule.

Returns:

  • (String)

See Also:



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

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'ssm_contacts/cfn_contact_props.rb', line 57

def self.jsii_properties
  {
    :_alias => "alias",
    :display_name => "displayName",
    :type => "type",
    :plan => "plan",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'ssm_contacts/cfn_contact_props.rb', line 67

def to_jsii
  result = {}
  result.merge!({
    "alias" => @_alias,
    "displayName" => @display_name,
    "type" => @type,
    "plan" => @plan,
    "tags" => @tags,
  })
  result.compact
end