Skip to content

Resource: awsDetectiveMember

Provides a resource to manage an Amazon Detective Member.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsDetectiveGraphExample = new aws.detectiveGraph.DetectiveGraph(
  this,
  "example",
  {}
);
const awsDetectiveMemberExample = new aws.detectiveMember.DetectiveMember(
  this,
  "example_1",
  {
    accountId: "AWS ACCOUNT ID",
    disableEmailNotification: true,
    emailAddress: "EMAIL",
    graphArn: awsDetectiveGraphExample.id,
    message: "Message of the invitation",
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsDetectiveMemberExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • accountId - (Required) AWS account ID for the account.
  • emailAddress - (Required) Email address for the account.
  • graphArn - (Required) ARN of the behavior graph to invite the member accounts to contribute their data to.
  • message - (Optional) A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
  • disableEmailNotification - (Optional) If set to true, then the root user of the invited account will not receive an email notification. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. By default, this is set to false.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - Unique identifier (ID) of the Detective.
  • status - Current membership status of the member account.
  • administratorId - AWS account ID for the administrator account.
  • volumeUsageInBytes - Data volume in bytes per day for the member account.
  • invitedTime - Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
  • updatedTime - Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.

Import

awsDetectiveMember can be imported using the ARN of the graph followed by the account ID of the member account, e.g.

$ terraform import aws_detective_member.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d/123456789012