Package software.amazon.awscdk.services.shield

Class CfnProactiveEngagement

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.shield.CfnProactiveEngagement
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.774Z") @Stability(Stable) public class CfnProactiveEngagement extends CfnResource implements IInspectable
A CloudFormation AWS::Shield::ProactiveEngagement.

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

To enable proactive engagement, you must be subscribed to the Business Support plan or the Enterprise Support plan .

To configure this resource through AWS CloudFormation , you must be subscribed to AWS Shield Advanced . You can subscribe through the Shield Advanced console and through the APIs. For more information, see Subscribe to AWS Shield Advanced .

See example templates for Shield Advanced in AWS CloudFormation at aws-samples/aws-shield-advanced-examples .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.shield.*;
 CfnProactiveEngagement cfnProactiveEngagement = CfnProactiveEngagement.Builder.create(this, "MyCfnProactiveEngagement")
         .emergencyContactList(List.of(EmergencyContactProperty.builder()
                 .emailAddress("emailAddress")
                 // the properties below are optional
                 .contactNotes("contactNotes")
                 .phoneNumber("phoneNumber")
                 .build()))
         .proactiveEngagementStatus("proactiveEngagementStatus")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnProactiveEngagement

      protected CfnProactiveEngagement(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProactiveEngagement

      protected CfnProactiveEngagement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProactiveEngagement

      @Stability(Stable) public CfnProactiveEngagement(@NotNull Construct scope, @NotNull String id, @NotNull CfnProactiveEngagementProps props)
      Create a new AWS::Shield::ProactiveEngagement.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAccountId

      @Stability(Stable) @NotNull public String getAttrAccountId()
      The ID of the account that submitted the template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEmergencyContactList

      @Stability(Stable) @NotNull public Object getEmergencyContactList()
      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.

    • setEmergencyContactList

      @Stability(Stable) public void setEmergencyContactList(@NotNull IResolvable value)
      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.

    • setEmergencyContactList

      @Stability(Stable) public void setEmergencyContactList(@NotNull List<Object> value)
      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.

    • getProactiveEngagementStatus

      @Stability(Stable) @NotNull public String getProactiveEngagementStatus()
      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.

    • setProactiveEngagementStatus

      @Stability(Stable) public void setProactiveEngagementStatus(@NotNull String value)
      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.