Class Member
Provides a resource to manage a GuardDuty member. To accept invitations in member accounts, see the aws.guardduty.InviteAccepter resource.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var master = new Aws.GuardDuty.Detector("master", new Aws.GuardDuty.DetectorArgs
{
Enable = true,
});
var memberDetector = new Aws.GuardDuty.Detector("memberDetector", new Aws.GuardDuty.DetectorArgs
{
Enable = true,
});
var memberMember = new Aws.GuardDuty.Member("memberMember", new Aws.GuardDuty.MemberArgs
{
AccountId = memberDetector.AccountId,
DetectorId = master.Id,
Email = "required@example.com",
Invite = true,
InvitationMessage = "please accept guardduty invitation",
});
}
}
Inherited Members
Namespace: Pulumi.Aws.GuardDuty
Assembly: Pulumi.Aws.dll
Syntax
public class Member : CustomResource
Constructors
View SourceMember(String, MemberArgs, CustomResourceOptions)
Create a Member resource with the given unique name, arguments, and options.
Declaration
public Member(string name, MemberArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| MemberArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAccountId
AWS account ID for member account.
Declaration
public Output<string> AccountId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
DetectorId
The detector ID of the GuardDuty account where you want to create member accounts.
Declaration
public Output<string> DetectorId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
DisableEmailNotification
Boolean whether an email notification is sent to the accounts. Defaults to false.
Declaration
public Output<bool?> DisableEmailNotification { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Email address for member account.
Declaration
public Output<string> Email { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
InvitationMessage
Message for invitation.
Declaration
public Output<string> InvitationMessage { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Invite
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 relationship_status of Disabled, Enabled, Invited, or EmailVerificationInProgress.
Declaration
public Output<bool?> Invite { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
RelationshipStatus
The status of the relationship between the member account and its master account. More information can be found in Amazon GuardDuty API Reference.
Declaration
public Output<string> RelationshipStatus { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, MemberState, CustomResourceOptions)
Get an existing Member resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Member Get(string name, Input<string> id, MemberState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| MemberState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Member |