CfnProactiveEngagementPropsMixin

class aws_cdk.mixins_preview.aws_shield.mixins.CfnProactiveEngagementPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-proactiveengagement.html
CloudformationResource:: AWS::Shield::ProactiveEngagement
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_shield import mixins as shield_mixins

cfn_proactive_engagement_props_mixin = shield_mixins.CfnProactiveEngagementPropsMixin(shield_mixins.CfnProactiveEngagementMixinProps(
    emergency_contact_list=[shield_mixins.CfnProactiveEngagementPropsMixin.EmergencyContactProperty(
        contact_notes="contactNotes",
        email_address="emailAddress",
        phone_number="phoneNumber"
    )],
    proactive_engagement_status="proactiveEngagementStatus"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Shield::ProactiveEngagement.

Parameters:

props (Union[CfnProactiveEngagementMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['emergencyContactList', 'proactiveEngagementStatus']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EmergencyContactProperty

class CfnProactiveEngagementPropsMixin.EmergencyContactProperty(*, contact_notes=None, email_address=None, phone_number=None)

Bases: object

Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

Parameters:

contact_notes (Optional[str]) – Additional notes regarding the contact.
email_address (Optional[str]) – The email address for the contact.
phone_number (Optional[str]) – The phone number for the contact.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_shield import mixins as shield_mixins

emergency_contact_property = shield_mixins.CfnProactiveEngagementPropsMixin.EmergencyContactProperty(
    contact_notes="contactNotes",
    email_address="emailAddress",
    phone_number="phoneNumber"
)

Attributes

contact_notes

Additional notes regarding the contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-contactnotes

email_address

The email address for the contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-emailaddress

phone_number

The phone number for the contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-shield-proactiveengagement-emergencycontact.html#cfn-shield-proactiveengagement-emergencycontact-phonenumber