Skip to content

Resource: awsMacie2Member

Provides a resource to manage an Amazon Macie 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 awsMacie2AccountExample = new aws.macie2Account.Macie2Account(
  this,
  "example",
  {}
);
const awsMacie2MemberExample = new aws.macie2Member.Macie2Member(
  this,
  "example_1",
  {
    accountId: "AWS ACCOUNT ID",
    depends_on: [`\${${awsMacie2AccountExample.fqn}}`],
    email: "EMAIL",
    invitationDisableEmailNotification: true,
    invitationMessage: "Message of the invitation",
    invite: true,
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsMacie2MemberExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • accountId - (Required) The AWS account ID for the account.
  • email - (Required) The email address for the account.
  • tags - (Optional) A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.
  • status - (Optional) Specifies the status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to enabled. Valid values are enabled or paused.
  • invite - (Optional) Send an invitation to a member
  • invitationMessage - (Optional) A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.
  • invitationDisableEmailNotification - (Optional) Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.

Attributes Reference

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

  • id - The unique identifier (ID) of the macie Member.
  • arn - The Amazon Resource Name (ARN) of the account.
  • relationshipStatus - The current status of the relationship between the account and the administrator account.
  • administratorAccountId - The AWS account ID for the administrator account.
  • invitedAt - The date and time, in UTC and extended RFC 3339 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
  • updatedAt - The date and time, in UTC and extended RFC 3339 format, of the most recent change to the status of the relationship between the account and the administrator account.

Import

awsMacie2Member can be imported using the account ID of the member account, e.g.,

$ terraform import aws_macie2_member.example 123456789012