1. Packages
  2. AWS Native
  3. API Docs
  4. shield
  5. getProactiveEngagement

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.shield.getProactiveEngagement

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    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.

    Using getProactiveEngagement

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProactiveEngagement(args: GetProactiveEngagementArgs, opts?: InvokeOptions): Promise<GetProactiveEngagementResult>
    function getProactiveEngagementOutput(args: GetProactiveEngagementOutputArgs, opts?: InvokeOptions): Output<GetProactiveEngagementResult>
    def get_proactive_engagement(account_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetProactiveEngagementResult
    def get_proactive_engagement_output(account_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetProactiveEngagementResult]
    func LookupProactiveEngagement(ctx *Context, args *LookupProactiveEngagementArgs, opts ...InvokeOption) (*LookupProactiveEngagementResult, error)
    func LookupProactiveEngagementOutput(ctx *Context, args *LookupProactiveEngagementOutputArgs, opts ...InvokeOption) LookupProactiveEngagementResultOutput

    > Note: This function is named LookupProactiveEngagement in the Go SDK.

    public static class GetProactiveEngagement 
    {
        public static Task<GetProactiveEngagementResult> InvokeAsync(GetProactiveEngagementArgs args, InvokeOptions? opts = null)
        public static Output<GetProactiveEngagementResult> Invoke(GetProactiveEngagementInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProactiveEngagementResult> getProactiveEngagement(GetProactiveEngagementArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:shield:getProactiveEngagement
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    The ID of the account that submitted the template.
    AccountId string
    The ID of the account that submitted the template.
    accountId String
    The ID of the account that submitted the template.
    accountId string
    The ID of the account that submitted the template.
    account_id str
    The ID of the account that submitted the template.
    accountId String
    The ID of the account that submitted the template.

    getProactiveEngagement Result

    The following output properties are available:

    AccountId string
    The ID of the account that submitted the template.
    EmergencyContactList List<Pulumi.AwsNative.Shield.Outputs.ProactiveEngagementEmergencyContact>
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    ProactiveEngagementStatus Pulumi.AwsNative.Shield.ProactiveEngagementStatus
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    AccountId string
    The ID of the account that submitted the template.
    EmergencyContactList []ProactiveEngagementEmergencyContact
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    ProactiveEngagementStatus ProactiveEngagementStatus
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    accountId String
    The ID of the account that submitted the template.
    emergencyContactList List<ProactiveEngagementEmergencyContact>
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    proactiveEngagementStatus ProactiveEngagementStatus
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    accountId string
    The ID of the account that submitted the template.
    emergencyContactList ProactiveEngagementEmergencyContact[]
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    proactiveEngagementStatus ProactiveEngagementStatus
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    account_id str
    The ID of the account that submitted the template.
    emergency_contact_list Sequence[ProactiveEngagementEmergencyContact]
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    proactive_engagement_status ProactiveEngagementStatus
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
    accountId String
    The ID of the account that submitted the template.
    emergencyContactList List<Property Map>
    A 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. To enable proactive engagement, the contact list must include at least one phone number.
    proactiveEngagementStatus "ENABLED" | "DISABLED"
    If 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. If DISABLED, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support.

    Supporting Types

    ProactiveEngagementEmergencyContact

    EmailAddress string
    The email address for the contact.
    ContactNotes string
    Additional notes regarding the contact.
    PhoneNumber string
    The phone number for the contact
    EmailAddress string
    The email address for the contact.
    ContactNotes string
    Additional notes regarding the contact.
    PhoneNumber string
    The phone number for the contact
    emailAddress String
    The email address for the contact.
    contactNotes String
    Additional notes regarding the contact.
    phoneNumber String
    The phone number for the contact
    emailAddress string
    The email address for the contact.
    contactNotes string
    Additional notes regarding the contact.
    phoneNumber string
    The phone number for the contact
    email_address str
    The email address for the contact.
    contact_notes str
    Additional notes regarding the contact.
    phone_number str
    The phone number for the contact
    emailAddress String
    The email address for the contact.
    contactNotes String
    Additional notes regarding the contact.
    phoneNumber String
    The phone number for the contact

    ProactiveEngagementStatus

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi