aws logo
AWS Classic v5.41.0, May 15 23

aws.securityhub.Member

Explore with Pulumi AI

Provides a Security Hub member resource.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var exampleAccount = new Aws.SecurityHub.Account("exampleAccount");

    var exampleMember = new Aws.SecurityHub.Member("exampleMember", new()
    {
        AccountId = "123456789012",
        Email = "example@example.com",
        Invite = true,
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            exampleAccount,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleAccount, err := securityhub.NewAccount(ctx, "exampleAccount", nil)
		if err != nil {
			return err
		}
		_, err = securityhub.NewMember(ctx, "exampleMember", &securityhub.MemberArgs{
			AccountId: pulumi.String("123456789012"),
			Email:     pulumi.String("example@example.com"),
			Invite:    pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAccount,
		}))
		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.securityhub.Account;
import com.pulumi.aws.securityhub.Member;
import com.pulumi.aws.securityhub.MemberArgs;
import com.pulumi.resources.CustomResourceOptions;
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 exampleAccount = new Account("exampleAccount");

        var exampleMember = new Member("exampleMember", MemberArgs.builder()        
            .accountId("123456789012")
            .email("example@example.com")
            .invite(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAccount)
                .build());

    }
}
import pulumi
import pulumi_aws as aws

example_account = aws.securityhub.Account("exampleAccount")
example_member = aws.securityhub.Member("exampleMember",
    account_id="123456789012",
    email="example@example.com",
    invite=True,
    opts=pulumi.ResourceOptions(depends_on=[example_account]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleAccount = new aws.securityhub.Account("exampleAccount", {});
const exampleMember = new aws.securityhub.Member("exampleMember", {
    accountId: "123456789012",
    email: "example@example.com",
    invite: true,
}, {
    dependsOn: [exampleAccount],
});
resources:
  exampleAccount:
    type: aws:securityhub:Account
  exampleMember:
    type: aws:securityhub:Member
    properties:
      accountId: '123456789012'
      email: example@example.com
      invite: true
    options:
      dependson:
        - ${exampleAccount}

Create 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,
           email: Optional[str] = None,
           invite: Optional[bool] = 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:securityhub: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

The ID of the member AWS account.

Email string

The email of the member AWS account.

Invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

AccountId string

The ID of the member AWS account.

Email string

The email of the member AWS account.

Invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

accountId String

The ID of the member AWS account.

email String

The email of the member AWS account.

invite Boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

accountId string

The ID of the member AWS account.

email string

The email of the member AWS account.

invite boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

account_id str

The ID of the member AWS account.

email str

The email of the member AWS account.

invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

accountId String

The ID of the member AWS account.

email String

The email of the member AWS account.

invite Boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

MasterId string

The ID of the master Security Hub AWS account.

MemberStatus string

The status of the member account relationship.

Id string

The provider-assigned unique ID for this managed resource.

MasterId string

The ID of the master Security Hub AWS account.

MemberStatus string

The status of the member account relationship.

id String

The provider-assigned unique ID for this managed resource.

masterId String

The ID of the master Security Hub AWS account.

memberStatus String

The status of the member account relationship.

id string

The provider-assigned unique ID for this managed resource.

masterId string

The ID of the master Security Hub AWS account.

memberStatus string

The status of the member account relationship.

id str

The provider-assigned unique ID for this managed resource.

master_id str

The ID of the master Security Hub AWS account.

member_status str

The status of the member account relationship.

id String

The provider-assigned unique ID for this managed resource.

masterId String

The ID of the master Security Hub AWS account.

memberStatus String

The status of the member account relationship.

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,
        email: Optional[str] = None,
        invite: Optional[bool] = None,
        master_id: Optional[str] = None,
        member_status: 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

The ID of the member AWS account.

Email string

The email of the member AWS account.

Invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

MasterId string

The ID of the master Security Hub AWS account.

MemberStatus string

The status of the member account relationship.

AccountId string

The ID of the member AWS account.

Email string

The email of the member AWS account.

Invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

MasterId string

The ID of the master Security Hub AWS account.

MemberStatus string

The status of the member account relationship.

accountId String

The ID of the member AWS account.

email String

The email of the member AWS account.

invite Boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

masterId String

The ID of the master Security Hub AWS account.

memberStatus String

The status of the member account relationship.

accountId string

The ID of the member AWS account.

email string

The email of the member AWS account.

invite boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

masterId string

The ID of the master Security Hub AWS account.

memberStatus string

The status of the member account relationship.

account_id str

The ID of the member AWS account.

email str

The email of the member AWS account.

invite bool

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

master_id str

The ID of the master Security Hub AWS account.

member_status str

The status of the member account relationship.

accountId String

The ID of the member AWS account.

email String

The email of the member AWS account.

invite Boolean

Boolean whether to invite the account to Security Hub as a member. Defaults to false.

masterId String

The ID of the master Security Hub AWS account.

memberStatus String

The status of the member account relationship.

Import

Security Hub members can be imported using their account ID, e.g.,

 $ pulumi import aws:securityhub/member:Member example 123456789012

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.