AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

Member

Provides a resource to manage an Amazon Detective Member.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleGraph, err := detective.NewGraph(ctx, "exampleGraph", nil)
		if err != nil {
			return err
		}
		_, err = detective.NewMember(ctx, "exampleMember", &detective.MemberArgs{
			AccountId:                pulumi.String("AWS ACCOUNT ID"),
			EmailAddress:             pulumi.String("EMAIL"),
			GraphArn:                 exampleGraph.ID(),
			Message:                  pulumi.String("Message of the invitation"),
			DisableEmailNotification: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 exampleGraph = new Graph("exampleGraph");

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

    }
}
import pulumi
import pulumi_aws as aws

example_graph = aws.detective.Graph("exampleGraph")
example_member = aws.detective.Member("exampleMember",
    account_id="AWS ACCOUNT ID",
    email_address="EMAIL",
    graph_arn=example_graph.id,
    message="Message of the invitation",
    disable_email_notification=True)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleGraph = new aws.detective.Graph("exampleGraph", {});
const exampleMember = new aws.detective.Member("exampleMember", {
    accountId: "AWS ACCOUNT ID",
    emailAddress: "EMAIL",
    graphArn: exampleGraph.id,
    message: "Message of the invitation",
    disableEmailNotification: true,
});
resources:
  exampleGraph:
    type: aws:detective:Graph
  exampleMember:
    type: aws:detective:Member
    properties:
      accountId: AWS ACCOUNT ID
      emailAddress: EMAIL
      graphArn: ${exampleGraph.id}
      message: Message of the invitation
      disableEmailNotification: true

Create a Member Resource

new Member(name: string, args: MemberArgs, opts?: CustomResourceOptions);
@overload
def Member(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account_id: Optional[str] = None,
           disable_email_notification: Optional[bool] = None,
           email_address: Optional[str] = None,
           graph_arn: Optional[str] = None,
           message: Optional[str] = None)
@overload
def Member(resource_name: str,
           args: MemberArgs,
           opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args MemberArgs
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 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 string
The unique name of the resource.
args MemberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MemberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MemberArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The Member resource accepts the following input properties:

AccountId string

AWS account ID for the account.

EmailAddress string

Email address for the account.

GraphArn string

ARN of the behavior graph to invite the member accounts to contribute their data to.

DisableEmailNotification 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 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 string

AWS account ID for the account.

EmailAddress string

Email address for the account.

GraphArn string

ARN of the behavior graph to invite the member accounts to contribute their data to.

DisableEmailNotification 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 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 String

AWS account ID for the account.

emailAddress String

Email address for the account.

graphArn String

ARN of the behavior graph to invite the member accounts to contribute their data to.

disableEmailNotification 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 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 string

AWS account ID for the account.

emailAddress string

Email address for the account.

graphArn string

ARN of the behavior graph to invite the member accounts to contribute their data to.

disableEmailNotification 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 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 str

AWS account ID for the account.

email_address str

Email address for the account.

graph_arn str

ARN of the behavior graph to invite the member accounts to contribute their data to.

disable_email_notification 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 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 String

AWS account ID for the account.

emailAddress String

Email address for the account.

graphArn String

ARN of the behavior graph to invite the member accounts to contribute their data to.

disableEmailNotification 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 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 an 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)
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:
AccountId string

AWS account ID for the account.

AdministratorId string

AWS account ID for the administrator account.

DisableEmailNotification 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 string

Email address for the account.

GraphArn 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 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 string

AWS account ID for the account.

AdministratorId string

AWS account ID for the administrator account.

DisableEmailNotification 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 string

Email address for the account.

GraphArn 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 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 String

AWS account ID for the account.

administratorId String

AWS account ID for the administrator account.

disableEmailNotification 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 String

Email address for the account.

graphArn 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 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 string

AWS account ID for the account.

administratorId string

AWS account ID for the administrator account.

disableEmailNotification 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 string

Email address for the account.

graphArn 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 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 str

AWS account ID for the account.

administrator_id str

AWS account ID for the administrator account.

disable_email_notification 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 str

Email address for the account.

graph_arn 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 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 String

AWS account ID for the account.

administratorId String

AWS account ID for the administrator account.

disableEmailNotification 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 String

Email address for the account.

graphArn 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 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

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.