administrator_accounts

Creates, updates, deletes, gets or lists an administrator_accounts resource.

Overview

Name	administrator_accounts
Type	Resource
Id	aws.securityhub.administrator_accounts

Fields

The following fields are returned by SELECT queries:

get_administrator_account

Name	Datatype	Description
account_id	string	The account ID of the Security Hub CSPM administrator account that the invitation was sent from.
invitation_id	string	The ID of the invitation sent to the member account. (pattern: <code>.\S.</code>)
invited_at	string (date-time)	The timestamp of when the invitation was sent.
member_status	string	The current status of the association between the member and administrator accounts. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_administrator_account	select	region		Provides the details for the Security Hub CSPM administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
disassociate_from_administrator_account	update	region		Disassociates the current Security Hub CSPM member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_administrator_account

Provides the details for the Security Hub CSPM administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.

SELECT
account_id,
invitation_id,
invited_at,
member_status
FROM aws.securityhub.administrator_accounts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

disassociate_from_administrator_account

Disassociates the current Security Hub CSPM member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.

UPDATE aws.securityhub.administrator_accounts
SET 
-- No updatable properties
WHERE 
region = '{{ region }}' --required;