1. Packages
  2. AWS
  3. API Docs
  4. detective
  5. Member
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.detective.Member

Explore with Pulumi AI

Provides a resource to manage an Amazon Detective Member.

Example Usage

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

const example = new aws.detective.Graph("example", {});
const exampleMember = new aws.detective.Member("example", {
    accountId: "AWS ACCOUNT ID",
    emailAddress: "EMAIL",
    graphArn: example.graphArn,
    message: "Message of the invitation",
    disableEmailNotification: true,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.detective.Graph("example")
example_member = aws.detective.Member("example",
    account_id="AWS ACCOUNT ID",
    email_address="EMAIL",
    graph_arn=example.graph_arn,
    message="Message of the invitation",
    disable_email_notification=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/detective"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := detective.NewGraph(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = detective.NewMember(ctx, "example", &detective.MemberArgs{
			AccountId:                pulumi.String("AWS ACCOUNT ID"),
			EmailAddress:             pulumi.String("EMAIL"),
			GraphArn:                 example.GraphArn,
			Message:                  pulumi.String("Message of the invitation"),
			DisableEmailNotification: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Detective.Graph("example");

    var exampleMember = new Aws.Detective.Member("example", new()
    {
        AccountId = "AWS ACCOUNT ID",
        EmailAddress = "EMAIL",
        GraphArn = example.GraphArn,
        Message = "Message of the invitation",
        DisableEmailNotification = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.detective.Graph;
import com.pulumi.aws.detective.Member;
import com.pulumi.aws.detective.MemberArgs;
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 Graph("example");

        var exampleMember = new Member("exampleMember", MemberArgs.builder()
            .accountId("AWS ACCOUNT ID")
            .emailAddress("EMAIL")
            .graphArn(example.graphArn())
            .message("Message of the invitation")
            .disableEmailNotification(true)
            .build());

    }
}
Copy
resources:
  example:
    type: aws:detective:Graph
  exampleMember:
    type: aws:detective:Member
    name: example
    properties:
      accountId: AWS ACCOUNT ID
      emailAddress: EMAIL
      graphArn: ${example.graphArn}
      message: Message of the invitation
      disableEmailNotification: true
Copy

Create Member Resource

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

Constructor syntax

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

@overload
def Member(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account_id: Optional[str] = None,
           email_address: Optional[str] = None,
           graph_arn: Optional[str] = None,
           disable_email_notification: Optional[bool] = None,
           message: Optional[str] = None)
func NewMember(ctx *Context, name string, args MemberArgs, opts ...ResourceOption) (*Member, error)
public Member(string name, MemberArgs args, CustomResourceOptions? opts = null)
public Member(String name, MemberArgs args)
public Member(String name, MemberArgs args, CustomResourceOptions options)
type: aws:detective:Member
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MemberArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MemberArgs
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 memberResource = new Aws.Detective.Member("memberResource", new()
{
    AccountId = "string",
    EmailAddress = "string",
    GraphArn = "string",
    DisableEmailNotification = false,
    Message = "string",
});
Copy
example, err := detective.NewMember(ctx, "memberResource", &detective.MemberArgs{
	AccountId:                pulumi.String("string"),
	EmailAddress:             pulumi.String("string"),
	GraphArn:                 pulumi.String("string"),
	DisableEmailNotification: pulumi.Bool(false),
	Message:                  pulumi.String("string"),
})
Copy
var memberResource = new Member("memberResource", MemberArgs.builder()
    .accountId("string")
    .emailAddress("string")
    .graphArn("string")
    .disableEmailNotification(false)
    .message("string")
    .build());
Copy
member_resource = aws.detective.Member("memberResource",
    account_id="string",
    email_address="string",
    graph_arn="string",
    disable_email_notification=False,
    message="string")
Copy
const memberResource = new aws.detective.Member("memberResource", {
    accountId: "string",
    emailAddress: "string",
    graphArn: "string",
    disableEmailNotification: false,
    message: "string",
});
Copy
type: aws:detective:Member
properties:
    accountId: string
    disableEmailNotification: false
    emailAddress: string
    graphArn: string
    message: string
Copy

Member Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Member resource accepts the following input properties:

AccountId
This property is required.
Changes to this property will trigger replacement.
string
AWS account ID for the account.
EmailAddress
This property is required.
Changes to this property will trigger replacement.
string
Email address for the account.
GraphArn
This property is required.
Changes to this property will trigger replacement.
string
ARN of the behavior graph to invite the member accounts to contribute their data to.
DisableEmailNotification Changes to this property will trigger replacement. bool
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.
Message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
AccountId
This property is required.
Changes to this property will trigger replacement.
string
AWS account ID for the account.
EmailAddress
This property is required.
Changes to this property will trigger replacement.
string
Email address for the account.
GraphArn
This property is required.
Changes to this property will trigger replacement.
string
ARN of the behavior graph to invite the member accounts to contribute their data to.
DisableEmailNotification Changes to this property will trigger replacement. bool
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.
Message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
accountId
This property is required.
Changes to this property will trigger replacement.
String
AWS account ID for the account.
emailAddress
This property is required.
Changes to this property will trigger replacement.
String
Email address for the account.
graphArn
This property is required.
Changes to this property will trigger replacement.
String
ARN of the behavior graph to invite the member accounts to contribute their data to.
disableEmailNotification Changes to this property will trigger replacement. Boolean
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.
message Changes to this property will trigger replacement. String
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
accountId
This property is required.
Changes to this property will trigger replacement.
string
AWS account ID for the account.
emailAddress
This property is required.
Changes to this property will trigger replacement.
string
Email address for the account.
graphArn
This property is required.
Changes to this property will trigger replacement.
string
ARN of the behavior graph to invite the member accounts to contribute their data to.
disableEmailNotification Changes to this property will trigger replacement. boolean
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.
message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
account_id
This property is required.
Changes to this property will trigger replacement.
str
AWS account ID for the account.
email_address
This property is required.
Changes to this property will trigger replacement.
str
Email address for the account.
graph_arn
This property is required.
Changes to this property will trigger replacement.
str
ARN of the behavior graph to invite the member accounts to contribute their data to.
disable_email_notification Changes to this property will trigger replacement. bool
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.
message Changes to this property will trigger replacement. str
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
accountId
This property is required.
Changes to this property will trigger replacement.
String
AWS account ID for the account.
emailAddress
This property is required.
Changes to this property will trigger replacement.
String
Email address for the account.
graphArn
This property is required.
Changes to this property will trigger replacement.
String
ARN of the behavior graph to invite the member accounts to contribute their data to.
disableEmailNotification Changes to this property will trigger replacement. Boolean
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.
message Changes to this property will trigger replacement. String
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.

Outputs

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

AdministratorId string
AWS account ID for the administrator account.
DisabledReason string
Id string
The provider-assigned unique ID for this managed resource.
InvitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
Status string
Current membership status of the member account.
UpdatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
VolumeUsageInBytes string
Data volume in bytes per day for the member account.
AdministratorId string
AWS account ID for the administrator account.
DisabledReason string
Id string
The provider-assigned unique ID for this managed resource.
InvitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
Status string
Current membership status of the member account.
UpdatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
VolumeUsageInBytes string
Data volume in bytes per day for the member account.
administratorId String
AWS account ID for the administrator account.
disabledReason String
id String
The provider-assigned unique ID for this managed resource.
invitedTime String
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
status String
Current membership status of the member account.
updatedTime String
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes String
Data volume in bytes per day for the member account.
administratorId string
AWS account ID for the administrator account.
disabledReason string
id string
The provider-assigned unique ID for this managed resource.
invitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
status string
Current membership status of the member account.
updatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes string
Data volume in bytes per day for the member account.
administrator_id str
AWS account ID for the administrator account.
disabled_reason str
id str
The provider-assigned unique ID for this managed resource.
invited_time str
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
status str
Current membership status of the member account.
updated_time str
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volume_usage_in_bytes str
Data volume in bytes per day for the member account.
administratorId String
AWS account ID for the administrator account.
disabledReason String
id String
The provider-assigned unique ID for this managed resource.
invitedTime String
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
status String
Current membership status of the member account.
updatedTime String
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes String
Data volume in bytes per day for the member account.

Look up Existing Member Resource

Get an existing Member 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?: MemberState, opts?: CustomResourceOptions): Member
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        administrator_id: Optional[str] = None,
        disable_email_notification: Optional[bool] = None,
        disabled_reason: Optional[str] = None,
        email_address: Optional[str] = None,
        graph_arn: Optional[str] = None,
        invited_time: Optional[str] = None,
        message: Optional[str] = None,
        status: Optional[str] = None,
        updated_time: Optional[str] = None,
        volume_usage_in_bytes: Optional[str] = None) -> Member
func GetMember(ctx *Context, name string, id IDInput, state *MemberState, opts ...ResourceOption) (*Member, error)
public static Member Get(string name, Input<string> id, MemberState? state, CustomResourceOptions? opts = null)
public static Member get(String name, Output<String> id, MemberState state, CustomResourceOptions options)
resources:  _:    type: aws:detective:Member    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountId Changes to this property will trigger replacement. string
AWS account ID for the account.
AdministratorId string
AWS account ID for the administrator account.
DisableEmailNotification Changes to this property will trigger replacement. bool
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.
DisabledReason string
EmailAddress Changes to this property will trigger replacement. string
Email address for the account.
GraphArn Changes to this property will trigger replacement. string
ARN of the behavior graph to invite the member accounts to contribute their data to.
InvitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
Message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
Status string
Current membership status of the member account.
UpdatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
VolumeUsageInBytes string
Data volume in bytes per day for the member account.
AccountId Changes to this property will trigger replacement. string
AWS account ID for the account.
AdministratorId string
AWS account ID for the administrator account.
DisableEmailNotification Changes to this property will trigger replacement. bool
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.
DisabledReason string
EmailAddress Changes to this property will trigger replacement. string
Email address for the account.
GraphArn Changes to this property will trigger replacement. string
ARN of the behavior graph to invite the member accounts to contribute their data to.
InvitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
Message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
Status string
Current membership status of the member account.
UpdatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
VolumeUsageInBytes string
Data volume in bytes per day for the member account.
accountId Changes to this property will trigger replacement. String
AWS account ID for the account.
administratorId String
AWS account ID for the administrator account.
disableEmailNotification Changes to this property will trigger replacement. Boolean
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.
disabledReason String
emailAddress Changes to this property will trigger replacement. String
Email address for the account.
graphArn Changes to this property will trigger replacement. String
ARN of the behavior graph to invite the member accounts to contribute their data to.
invitedTime String
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
message Changes to this property will trigger replacement. String
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
status String
Current membership status of the member account.
updatedTime String
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes String
Data volume in bytes per day for the member account.
accountId Changes to this property will trigger replacement. string
AWS account ID for the account.
administratorId string
AWS account ID for the administrator account.
disableEmailNotification Changes to this property will trigger replacement. boolean
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.
disabledReason string
emailAddress Changes to this property will trigger replacement. string
Email address for the account.
graphArn Changes to this property will trigger replacement. string
ARN of the behavior graph to invite the member accounts to contribute their data to.
invitedTime string
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
message Changes to this property will trigger replacement. string
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
status string
Current membership status of the member account.
updatedTime string
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes string
Data volume in bytes per day for the member account.
account_id Changes to this property will trigger replacement. str
AWS account ID for the account.
administrator_id str
AWS account ID for the administrator account.
disable_email_notification Changes to this property will trigger replacement. bool
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.
disabled_reason str
email_address Changes to this property will trigger replacement. str
Email address for the account.
graph_arn Changes to this property will trigger replacement. str
ARN of the behavior graph to invite the member accounts to contribute their data to.
invited_time str
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
message Changes to this property will trigger replacement. str
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
status str
Current membership status of the member account.
updated_time str
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volume_usage_in_bytes str
Data volume in bytes per day for the member account.
accountId Changes to this property will trigger replacement. String
AWS account ID for the account.
administratorId String
AWS account ID for the administrator account.
disableEmailNotification Changes to this property will trigger replacement. Boolean
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.
disabledReason String
emailAddress Changes to this property will trigger replacement. String
Email address for the account.
graphArn Changes to this property will trigger replacement. String
ARN of the behavior graph to invite the member accounts to contribute their data to.
invitedTime String
Date and time, in UTC and extended RFC 3339 format, when an Amazon Detective membership invitation was last sent to the account.
message Changes to this property will trigger replacement. String
A custom message to include in the invitation. Amazon Detective adds this message to the standard content that it sends for an invitation.
status String
Current membership status of the member account.
updatedTime String
Date and time, in UTC and extended RFC 3339 format, of the most recent change to the member account's status.
volumeUsageInBytes String
Data volume in bytes per day for the member account.

Import

Using pulumi import, import aws_detective_member using the ARN of the graph followed by the account ID of the member account. For example:

$ pulumi import aws:detective/member:Member example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d/123456789012
Copy

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.