Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. shield
  5. ProactiveEngagement

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.shield.ProactiveEngagement

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing a AWS Shield Proactive Engagement. Proactive engagement 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.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.iam.Role("example", {
    name: awsShieldDrtAccessRoleArn,
    assumeRolePolicy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Sid: "",
            Effect: "Allow",
            Principal: {
                Service: "drt.shield.amazonaws.com",
            },
            Action: "sts:AssumeRole",
        }],
    }),
});
const exampleRolePolicyAttachment = new aws.iam.RolePolicyAttachment("example", {
    role: example.name,
    policyArn: "arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy",
});
const exampleDrtAccessRoleArnAssociation = new aws.shield.DrtAccessRoleArnAssociation("example", {roleArn: example.arn});
const test = new aws.shield.ProtectionGroup("test", {
    protectionGroupId: "example",
    aggregation: "MAX",
    pattern: "ALL",
});
const testProactiveEngagement = new aws.shield.ProactiveEngagement("test", {
    enabled: true,
    emergencyContacts: [
        {
            contactNotes: "Notes",
            emailAddress: "test@company.com",
            phoneNumber: "+12358132134",
        },
        {
            contactNotes: "Notes 2",
            emailAddress: "test2@company.com",
            phoneNumber: "+12358132134",
        },
    ],
}, {
    dependsOn: [testAwsShieldDrtAccessRoleArnAssociation],
});

    import pulumi
import json
import pulumi_aws as aws

example = aws.iam.Role("example",
    name=aws_shield_drt_access_role_arn,
    assume_role_policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service": "drt.shield.amazonaws.com",
            },
            "Action": "sts:AssumeRole",
        }],
    }))
example_role_policy_attachment = aws.iam.RolePolicyAttachment("example",
    role=example.name,
    policy_arn="arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy")
example_drt_access_role_arn_association = aws.shield.DrtAccessRoleArnAssociation("example", role_arn=example.arn)
test = aws.shield.ProtectionGroup("test",
    protection_group_id="example",
    aggregation="MAX",
    pattern="ALL")
test_proactive_engagement = aws.shield.ProactiveEngagement("test",
    enabled=True,
    emergency_contacts=[
        {
            "contactNotes": "Notes",
            "emailAddress": "test@company.com",
            "phoneNumber": "+12358132134",
        },
        {
            "contactNotes": "Notes 2",
            "emailAddress": "test2@company.com",
            "phoneNumber": "+12358132134",
        },
    ],
    opts = pulumi.ResourceOptions(depends_on=[test_aws_shield_drt_access_role_arn_association]))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/shield"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Sid":    "",
					"Effect": "Allow",
					"Principal": map[string]interface{}{
						"Service": "drt.shield.amazonaws.com",
					},
					"Action": "sts:AssumeRole",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		example, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
			Name:             pulumi.Any(awsShieldDrtAccessRoleArn),
			AssumeRolePolicy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewRolePolicyAttachment(ctx, "example", &iam.RolePolicyAttachmentArgs{
			Role:      example.Name,
			PolicyArn: pulumi.String("arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy"),
		})
		if err != nil {
			return err
		}
		_, err = shield.NewDrtAccessRoleArnAssociation(ctx, "example", &shield.DrtAccessRoleArnAssociationArgs{
			RoleArn: example.Arn,
		})
		if err != nil {
			return err
		}
		_, err = shield.NewProtectionGroup(ctx, "test", &shield.ProtectionGroupArgs{
			ProtectionGroupId: pulumi.String("example"),
			Aggregation:       pulumi.String("MAX"),
			Pattern:           pulumi.String("ALL"),
		})
		if err != nil {
			return err
		}
		_, err = shield.NewProactiveEngagement(ctx, "test", &shield.ProactiveEngagementArgs{
			Enabled: pulumi.Bool(true),
			EmergencyContacts: shield.ProactiveEngagementEmergencyContactArray{
				&shield.ProactiveEngagementEmergencyContactArgs{
					ContactNotes: pulumi.String("Notes"),
					EmailAddress: pulumi.String("test@company.com"),
					PhoneNumber:  pulumi.String("+12358132134"),
				},
				&shield.ProactiveEngagementEmergencyContactArgs{
					ContactNotes: pulumi.String("Notes 2"),
					EmailAddress: pulumi.String("test2@company.com"),
					PhoneNumber:  pulumi.String("+12358132134"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			testAwsShieldDrtAccessRoleArnAssociation,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Iam.Role("example", new()
    {
        Name = awsShieldDrtAccessRoleArn,
        AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Sid"] = "",
                    ["Effect"] = "Allow",
                    ["Principal"] = new Dictionary<string, object?>
                    {
                        ["Service"] = "drt.shield.amazonaws.com",
                    },
                    ["Action"] = "sts:AssumeRole",
                },
            },
        }),
    });

    var exampleRolePolicyAttachment = new Aws.Iam.RolePolicyAttachment("example", new()
    {
        Role = example.Name,
        PolicyArn = "arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy",
    });

    var exampleDrtAccessRoleArnAssociation = new Aws.Shield.DrtAccessRoleArnAssociation("example", new()
    {
        RoleArn = example.Arn,
    });

    var test = new Aws.Shield.ProtectionGroup("test", new()
    {
        ProtectionGroupId = "example",
        Aggregation = "MAX",
        Pattern = "ALL",
    });

    var testProactiveEngagement = new Aws.Shield.ProactiveEngagement("test", new()
    {
        Enabled = true,
        EmergencyContacts = new[]
        {
            new Aws.Shield.Inputs.ProactiveEngagementEmergencyContactArgs
            {
                ContactNotes = "Notes",
                EmailAddress = "test@company.com",
                PhoneNumber = "+12358132134",
            },
            new Aws.Shield.Inputs.ProactiveEngagementEmergencyContactArgs
            {
                ContactNotes = "Notes 2",
                EmailAddress = "test2@company.com",
                PhoneNumber = "+12358132134",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            testAwsShieldDrtAccessRoleArnAssociation,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicyAttachment;
import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
import com.pulumi.aws.shield.DrtAccessRoleArnAssociation;
import com.pulumi.aws.shield.DrtAccessRoleArnAssociationArgs;
import com.pulumi.aws.shield.ProtectionGroup;
import com.pulumi.aws.shield.ProtectionGroupArgs;
import com.pulumi.aws.shield.ProactiveEngagement;
import com.pulumi.aws.shield.ProactiveEngagementArgs;
import com.pulumi.aws.shield.inputs.ProactiveEngagementEmergencyContactArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Role("example", RoleArgs.builder()
            .name(awsShieldDrtAccessRoleArn)
            .assumeRolePolicy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Sid", ""),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Principal", jsonObject(
                            jsonProperty("Service", "drt.shield.amazonaws.com")
                        )),
                        jsonProperty("Action", "sts:AssumeRole")
                    )))
                )))
            .build());

        var exampleRolePolicyAttachment = new RolePolicyAttachment("exampleRolePolicyAttachment", RolePolicyAttachmentArgs.builder()
            .role(example.name())
            .policyArn("arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy")
            .build());

        var exampleDrtAccessRoleArnAssociation = new DrtAccessRoleArnAssociation("exampleDrtAccessRoleArnAssociation", DrtAccessRoleArnAssociationArgs.builder()
            .roleArn(example.arn())
            .build());

        var test = new ProtectionGroup("test", ProtectionGroupArgs.builder()
            .protectionGroupId("example")
            .aggregation("MAX")
            .pattern("ALL")
            .build());

        var testProactiveEngagement = new ProactiveEngagement("testProactiveEngagement", ProactiveEngagementArgs.builder()
            .enabled(true)
            .emergencyContacts(            
                ProactiveEngagementEmergencyContactArgs.builder()
                    .contactNotes("Notes")
                    .emailAddress("test@company.com")
                    .phoneNumber("+12358132134")
                    .build(),
                ProactiveEngagementEmergencyContactArgs.builder()
                    .contactNotes("Notes 2")
                    .emailAddress("test2@company.com")
                    .phoneNumber("+12358132134")
                    .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(testAwsShieldDrtAccessRoleArnAssociation)
                .build());

    }
}

    resources:
  example:
    type: aws:iam:Role
    properties:
      name: ${awsShieldDrtAccessRoleArn}
      assumeRolePolicy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Sid:
              Effect: Allow
              Principal:
                Service: drt.shield.amazonaws.com
              Action: sts:AssumeRole
  exampleRolePolicyAttachment:
    type: aws:iam:RolePolicyAttachment
    name: example
    properties:
      role: ${example.name}
      policyArn: arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy
  exampleDrtAccessRoleArnAssociation:
    type: aws:shield:DrtAccessRoleArnAssociation
    name: example
    properties:
      roleArn: ${example.arn}
  test:
    type: aws:shield:ProtectionGroup
    properties:
      protectionGroupId: example
      aggregation: MAX
      pattern: ALL
  testProactiveEngagement:
    type: aws:shield:ProactiveEngagement
    name: test
    properties:
      enabled: true
      emergencyContacts:
        - contactNotes: Notes
          emailAddress: test@company.com
          phoneNumber: '+12358132134'
        - contactNotes: Notes 2
          emailAddress: test2@company.com
          phoneNumber: '+12358132134'
    options:
      dependson:
        - ${testAwsShieldDrtAccessRoleArnAssociation}

    Create ProactiveEngagement Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProactiveEngagement(name: string, args: ProactiveEngagementArgs, opts?: CustomResourceOptions);
    @overload
def ProactiveEngagement(resource_name: str,
                        args: ProactiveEngagementArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def ProactiveEngagement(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        enabled: Optional[bool] = None,
                        emergency_contacts: Optional[Sequence[ProactiveEngagementEmergencyContactArgs]] = None)
    func NewProactiveEngagement(ctx *Context, name string, args ProactiveEngagementArgs, opts ...ResourceOption) (*ProactiveEngagement, error)
    public ProactiveEngagement(string name, ProactiveEngagementArgs args, CustomResourceOptions? opts = null)
    public ProactiveEngagement(String name, ProactiveEngagementArgs args)
public ProactiveEngagement(String name, ProactiveEngagementArgs args, CustomResourceOptions options)

    type: aws:shield:ProactiveEngagement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProactiveEngagementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProactiveEngagementArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProactiveEngagementArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProactiveEngagementArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProactiveEngagementArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var proactiveEngagementResource = new Aws.Shield.ProactiveEngagement("proactiveEngagementResource", new()
{
    Enabled = false,
    EmergencyContacts = new[]
    {
        new Aws.Shield.Inputs.ProactiveEngagementEmergencyContactArgs
        {
            EmailAddress = "string",
            ContactNotes = "string",
            PhoneNumber = "string",
        },
    },
});

    example, err := shield.NewProactiveEngagement(ctx, "proactiveEngagementResource", &shield.ProactiveEngagementArgs{
	Enabled: pulumi.Bool(false),
	EmergencyContacts: shield.ProactiveEngagementEmergencyContactArray{
		&shield.ProactiveEngagementEmergencyContactArgs{
			EmailAddress: pulumi.String("string"),
			ContactNotes: pulumi.String("string"),
			PhoneNumber:  pulumi.String("string"),
		},
	},
})

    var proactiveEngagementResource = new ProactiveEngagement("proactiveEngagementResource", ProactiveEngagementArgs.builder()
    .enabled(false)
    .emergencyContacts(ProactiveEngagementEmergencyContactArgs.builder()
        .emailAddress("string")
        .contactNotes("string")
        .phoneNumber("string")
        .build())
    .build());

    proactive_engagement_resource = aws.shield.ProactiveEngagement("proactiveEngagementResource",
    enabled=False,
    emergency_contacts=[{
        "emailAddress": "string",
        "contactNotes": "string",
        "phoneNumber": "string",
    }])

    const proactiveEngagementResource = new aws.shield.ProactiveEngagement("proactiveEngagementResource", {
    enabled: false,
    emergencyContacts: [{
        emailAddress: "string",
        contactNotes: "string",
        phoneNumber: "string",
    }],
});

    type: aws:shield:ProactiveEngagement
properties:
    emergencyContacts:
        - contactNotes: string
          emailAddress: string
          phoneNumber: string
    enabled: false

    ProactiveEngagement Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ProactiveEngagement resource accepts the following input properties:

    Enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    EmergencyContacts List<ProactiveEngagementEmergencyContact>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    Enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    EmergencyContacts []ProactiveEngagementEmergencyContactArgs
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled Boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts List<ProactiveEngagementEmergencyContact>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts ProactiveEngagementEmergencyContact[]
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergency_contacts Sequence[ProactiveEngagementEmergencyContactArgs]
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled Boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts List<Property Map>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProactiveEngagement resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ProactiveEngagement Resource

    Get an existing ProactiveEngagement resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProactiveEngagementState, opts?: CustomResourceOptions): ProactiveEngagement
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        emergency_contacts: Optional[Sequence[ProactiveEngagementEmergencyContactArgs]] = None,
        enabled: Optional[bool] = None) -> ProactiveEngagement
    func GetProactiveEngagement(ctx *Context, name string, id IDInput, state *ProactiveEngagementState, opts ...ResourceOption) (*ProactiveEngagement, error)
    public static ProactiveEngagement Get(string name, Input<string> id, ProactiveEngagementState? state, CustomResourceOptions? opts = null)
    public static ProactiveEngagement get(String name, Output<String> id, ProactiveEngagementState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EmergencyContacts List<ProactiveEngagementEmergencyContact>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    Enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    EmergencyContacts []ProactiveEngagementEmergencyContactArgs
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    Enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts List<ProactiveEngagementEmergencyContact>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled Boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts ProactiveEngagementEmergencyContact[]
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergency_contacts Sequence[ProactiveEngagementEmergencyContactArgs]
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled bool
    Boolean value indicating if Proactive Engagement should be enabled or not.
    emergencyContacts List<Property Map>
    One or more emergency contacts. You must provide at least one phone number in the emergency contact list. See emergency_contacts.
    enabled Boolean
    Boolean value indicating if Proactive Engagement should be enabled or not.

    Supporting Types

    ProactiveEngagementEmergencyContact, ProactiveEngagementEmergencyContactArgs

    Import

    Using pulumi import, import Shield proactive engagement using the AWS account ID. For example:

    $ pulumi import aws:shield/proactiveEngagement:ProactiveEngagement example 123456789012

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws