Class CfnProactiveEngagement
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.
Implements
Inherited Members
Namespace: Amazon.CDK.AwsShield
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnProactiveEngagement : CfnResource, IInspectable
Syntax (vb)
Public Class CfnProactiveEngagement
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::Shield::ProactiveEngagement
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_shield;
var cfnProactiveEngagement = new CfnProactiveEngagement(this, "MyCfnProactiveEngagement", new CfnProactiveEngagementProps {
EmergencyContactList = new [] { new EmergencyContactProperty {
EmailAddress = "emailAddress",
// the properties below are optional
ContactNotes = "contactNotes",
PhoneNumber = "phoneNumber"
} },
ProactiveEngagementStatus = "proactiveEngagementStatus"
});
Synopsis
Constructors
CfnProactiveEngagement(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProactiveEngagement(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnProactiveEngagement(Construct, String, ICfnProactiveEngagementProps) |
Properties
AttrAccountId | The ID of the account that submitted the template. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EmergencyContactList | 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. |
ProactiveEngagementStatus | Specifies whether proactive engagement is enabled or disabled. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnProactiveEngagement(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProactiveEngagement(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProactiveEngagement(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProactiveEngagement(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnProactiveEngagement(Construct, String, ICfnProactiveEngagementProps)
public CfnProactiveEngagement(Construct scope, string id, ICfnProactiveEngagementProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnProactiveEngagementProps
Resource properties.
Properties
AttrAccountId
The ID of the account that submitted the template.
public virtual string AttrAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AccountId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EmergencyContactList
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.
public virtual object EmergencyContactList { get; set; }
Property Value
System.Object
ProactiveEngagementStatus
Specifies whether proactive engagement is enabled or disabled.
public virtual string ProactiveEngagementStatus { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>