Class CfnProactiveEngagement
A CloudFormation AWS::Shield::ProactiveEngagement
.
Inherited Members
Namespace: Amazon.CDK.AWS.Shield
Assembly: Amazon.CDK.AWS.Shield.dll
Syntax (csharp)
public class CfnProactiveEngagement : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProactiveEngagement
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
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(Construct, String, ICfnProactiveEngagementProps) | Create a new |
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 |
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(Construct, String, ICfnProactiveEngagementProps)
Create a new AWS::Shield::ProactiveEngagement
.
public CfnProactiveEngagement(Construct scope, string id, ICfnProactiveEngagementProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnProactiveEngagementProps
- resource properties.
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
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
Remarks
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:
ProactiveEngagementStatus
Specifies whether proactive engagement is enabled or disabled.
public virtual string ProactiveEngagementStatus { get; set; }
Property Value
System.String
Remarks
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.
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>