Class: AWSCDK::Shield::CfnProactiveEngagementProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
shield/cfn_proactive_engagement_props.rb

Overview

Properties for defining a CfnProactiveEngagement.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(emergency_contact_list:, proactive_engagement_status:) ⇒ CfnProactiveEngagementProps

Returns a new instance of CfnProactiveEngagementProps.

Parameters:



11
12
13
14
15
16
 
# File 'shield/cfn_proactive_engagement_props.rb', line 11

def initialize(emergency_contact_list:, proactive_engagement_status:)
  @emergency_contact_list = emergency_contact_list
  Jsii::Type.check_type(@emergency_contact_list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2hpZWxkLkNmblByb2FjdGl2ZUVuZ2FnZW1lbnQuRW1lcmdlbmN5Q29udGFjdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "emergencyContactList")
  @proactive_engagement_status = proactive_engagement_status
  Jsii::Type.check_type(@proactive_engagement_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "proactiveEngagementStatus")
end

Instance Attribute Details

#emergency_contact_list ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Shield::CfnProactiveEngagement::EmergencyContactProperty> (readonly)

The list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support, plus any relevant notes.

To enable proactive engagement, the contact list must include at least one phone number.

If you provide more than one contact, in the notes, indicate the circumstances under which each contact should be used. Include primary and secondary contact designations, and provide the hours of availability and time zones for each contact.

Example contact notes:

  • This is a hotline that's staffed 24x7x365. Please work with the responding analyst and they will get the appropriate person on the call.
  • Please contact the secondary phone number if the hotline doesn't respond within 5 minutes.

Returns:

See Also:



31
32
33
 
# File 'shield/cfn_proactive_engagement_props.rb', line 31

def emergency_contact_list
  @emergency_contact_list
end

#proactive_engagement_status ⇒ String (readonly)

Specifies whether proactive engagement is enabled or disabled.

Valid values:

ENABLED - The Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

DISABLED - The SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'shield/cfn_proactive_engagement_props.rb', line 42

def proactive_engagement_status
  @proactive_engagement_status
end

Class Method Details

.jsii_properties ⇒ Object 



44
45
46
47
48
49
 
# File 'shield/cfn_proactive_engagement_props.rb', line 44

def self.jsii_properties
  {
    :emergency_contact_list => "emergencyContactList",
    :proactive_engagement_status => "proactiveEngagementStatus",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'shield/cfn_proactive_engagement_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "emergencyContactList" => @emergency_contact_list,
    "proactiveEngagementStatus" => @proactive_engagement_status,
  })
  result.compact
end