Package software.amazon.awscdk.services.shield

Class CfnProactiveEngagement

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.shield.CfnProactiveEngagement
All Implemented Interfaces:
IInspectable, IProactiveEngagementRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:48.991Z") @Stability(Stable) public class CfnProactiveEngagement extends CfnResource implements IInspectable, IProactiveEngagementRef
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 .

Configure AWS::Shield::ProactiveEngagement for one account

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 .

Configure Shield Advanced using AWS CloudFormation and AWS Firewall Manager

You might be able to use Firewall Manager with AWS CloudFormation to configure Shield Advanced across multiple accounts and protected resources. To do this, your accounts must be part of an organization in AWS Organizations . You can use Firewall Manager to configure Shield Advanced protections for any resource types except for Amazon Route 53 or AWS Global Accelerator .

For an example of this, see the one-click configuration guidance published by the AWS technical community at One-click deployment of Shield Advanced .

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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnProactiveEngagementProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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

    • getProactiveEngagementRef

      @Stability(Stable) @NotNull public ProactiveEngagementReference getProactiveEngagementRef()
      A reference to a ProactiveEngagement resource.
      Specified by:
      getProactiveEngagementRef in interface IProactiveEngagementRef

    • 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.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProactiveEngagement.EmergencyContactProperty>

    • 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.

    • 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.

    • getProactiveEngagementStatus

      @Stability(Stable) @NotNull public String getProactiveEngagementStatus()
      Specifies whether proactive engagement is enabled or disabled.

    • setProactiveEngagementStatus

      @Stability(Stable) public void setProactiveEngagementStatus(@NotNull String value)
      Specifies whether proactive engagement is enabled or disabled.