Member class

Provides a resource to manage a GuardDuty member. To accept invitations in member accounts, see the aws.guardduty.InviteAccepter resource.

Example Usage

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

const primary = new aws.guardduty.Detector("primary", {enable: true});
const member = new aws.guardduty.Detector("member", {enable: true});
const memberMember = new aws.guardduty.Member("member", {
    accountId: member.accountId,
    detectorId: primary.id,
    email: "required@example.com",
    invite: true,
    invitationMessage: "please accept guardduty invitation",
});
import pulumi
import pulumi_aws as aws

primary = aws.guardduty.Detector("primary", enable=True)
member = aws.guardduty.Detector("member", enable=True)
member_member = aws.guardduty.Member("member",
    account_id=member.account_id,
    detector_id=primary.id,
    email="required@example.com",
    invite=True,
    invitation_message="please accept guardduty invitation")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var primary = new Aws.GuardDuty.Detector("primary", new()
    {
        Enable = true,
    });

    var member = new Aws.GuardDuty.Detector("member", new()
    {
        Enable = true,
    });

    var memberMember = new Aws.GuardDuty.Member("member", new()
    {
        AccountId = member.AccountId,
        DetectorId = primary.Id,
        Email = "required@example.com",
        Invite = true,
        InvitationMessage = "please accept guardduty invitation",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/guardduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		primary, err := guardduty.NewDetector(ctx, "primary", &guardduty.DetectorArgs{
			Enable: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		member, err := guardduty.NewDetector(ctx, "member", &guardduty.DetectorArgs{
			Enable: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = guardduty.NewMember(ctx, "member", &guardduty.MemberArgs{
			AccountId:         member.AccountId,
			DetectorId:        primary.ID().ToIDOutput().ToStringOutput(),
			Email:             pulumi.String("required@example.com"),
			Invite:            pulumi.Bool(true),
			InvitationMessage: pulumi.String("please accept guardduty invitation"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_guardduty_detector" "primary" {
  enable = true
}
resource "aws_guardduty_detector" "member" {
  enable = true
}
resource "aws_guardduty_member" "member" {
  account_id         = aws_guardduty_detector.member.account_id
  detector_id        = aws_guardduty_detector.primary.id
  email              = "required@example.com"
  invite             = true
  invitation_message = "please accept guardduty invitation"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.guardduty.Detector;
import com.pulumi.aws.guardduty.DetectorArgs;
import com.pulumi.aws.guardduty.Member;
import com.pulumi.aws.guardduty.MemberArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 primary = new Detector("primary", DetectorArgs.builder()
            .enable(true)
            .build());

        var member = new Detector("member", DetectorArgs.builder()
            .enable(true)
            .build());

        var memberMember = new Member("memberMember", MemberArgs.builder()
            .accountId(member.accountId())
            .detectorId(primary.id())
            .email("required@example.com")
            .invite(true)
            .invitationMessage("please accept guardduty invitation")
            .build());

    }
}
resources:
  primary:
    type: aws:guardduty:Detector
    properties:
      enable: true
  member:
    type: aws:guardduty:Detector
    properties:
      enable: true
  memberMember:
    type: aws:guardduty:Member
    name: member
    properties:
      accountId: ${member.accountId}
      detectorId: ${primary.id}
      email: required@example.com
      invite: true
      invitationMessage: please accept guardduty invitation

Import

Using pulumi import, import GuardDuty members using the primary GuardDuty detector ID and member AWS account ID. For example:

$ pulumi import aws:guardduty/member:Member MyMember 00b00fd5aecc0ab60a708659477e9617:123456789012

Constructors

Member(String name, {MemberArgs? args, CustomResourceOptions? options})
Creates a new Member. name The Pulumi resource name. args Arguments used to configure this Member. The set of arguments for Member. options Resource options controlling this resource's behavior.
Member.reference(String urn)
Creates a typed reference to an existing Member resource.

Properties

accountId ↔ Output<String>
AWS account ID for member account.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
detectorId ↔ Output<String>
The detector ID of the GuardDuty account where you want to create member accounts.
latefinal
disableEmailNotification ↔ Output<bool?>
Boolean whether an email notification is sent to the accounts. Defaults to false.
latefinal
email ↔ Output<String>
Email address for member account.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
invitationMessage ↔ Output<String?>
Message for invitation.
latefinal
invite ↔ Output<bool?>
Boolean whether to invite the account to GuardDuty as a member. Defaults to false. To detect if an invitation needs to be (re-)sent, the this provider state value is true based on a relationshipStatus of Disabled, Enabled, Invited, or EmailVerificationInProgress.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
relationshipStatus ↔ Output<String>
The status of the relationship between the member account and its primary account. More information can be found in Amazon GuardDuty API Reference.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {MemberState? state, CustomResourceOptions? options}) → Member
Gets an existing Member resource's state with the given name and id.