libZSservicesZSamazonka-securityhubZSamazonka-securityhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecurityHub.CreateMembers

Description

Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.

CreateMembers is always used to add accounts that are not organization members.

For accounts that are managed using Organizations, CreateMembers is only used in the following cases:

  • Security Hub is not configured to automatically add new organization accounts.
  • The account was disassociated or deleted in Security Hub.

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.

For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.

Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.

  • If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
  • For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

A permissions policy is added that permits the administrator account to view the findings generated in the member account.

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

Synopsis

Creating a Request

data CreateMembers Source #

See: newCreateMembers smart constructor.

Constructors

CreateMembers' 

Fields

  • accountDetails :: [AccountDetails]

    The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

Instances

Instances details
Eq CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Read CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Show CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Generic CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Associated Types

type Rep CreateMembers :: Type -> Type #

NFData CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Methods

rnf :: CreateMembers -> () #

Hashable CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

ToJSON CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

AWSRequest CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Associated Types

type AWSResponse CreateMembers #

ToHeaders CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

ToPath CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

ToQuery CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

type Rep CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

type Rep CreateMembers = D1 ('MetaData "CreateMembers" "Amazonka.SecurityHub.CreateMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AccountDetails])))
type AWSResponse CreateMembers Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

newCreateMembers :: CreateMembers Source #

Create a value of CreateMembers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountDetails:CreateMembers', createMembers_accountDetails - The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

Request Lenses

createMembers_accountDetails :: Lens' CreateMembers [AccountDetails] Source #

The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.

Destructuring the Response

data CreateMembersResponse Source #

See: newCreateMembersResponse smart constructor.

Constructors

CreateMembersResponse' 

Fields

  • unprocessedAccounts :: Maybe [Result]

    The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Read CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Show CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Generic CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Associated Types

type Rep CreateMembersResponse :: Type -> Type #

NFData CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

Methods

rnf :: CreateMembersResponse -> () #

type Rep CreateMembersResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateMembers

type Rep CreateMembersResponse = D1 ('MetaData "CreateMembersResponse" "Amazonka.SecurityHub.CreateMembers" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Result])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateMembersResponse Source #

Create a value of CreateMembersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:unprocessedAccounts:CreateMembersResponse', createMembersResponse_unprocessedAccounts - The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

$sel:httpStatus:CreateMembersResponse', createMembersResponse_httpStatus - The response's http status code.

Response Lenses

createMembersResponse_unprocessedAccounts :: Lens' CreateMembersResponse (Maybe [Result]) Source #

The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.