organization_admins

Creates, updates, deletes or gets an organization_admin resource or lists organization_admins in a region

Overview

Name	organization_admins
Type	Resource
Description	Resource schema for AWS::Detective::OrganizationAdmin
Id	awscc.detective.organization_admins

Fields

get (all properties)

Name	Datatype	Description
account_id	string	The account ID of the account that should be registered as your Organization's delegated administrator for Detective
graph_arn	string	The Detective graph ARN
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string	The account ID of the account that should be registered as your Organization's delegated administrator for Detective
region	string	AWS region.

For more information, see AWS::Detective::OrganizationAdmin.

Methods

Name	Resource	Accessible by	Required Params
create_resource	organization_admins	INSERT	AccountId, region
delete_resource	organization_admins	DELETE	Identifier, region
list_resources	organization_admins_list_only	SELECT	region
get_resource	organization_admins	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual organization_admin.

SELECT
  region,
  account_id,
  graph_arn
FROM awscc.detective.organization_admins
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all organization_admins in a region.

SELECT
  region,
  account_id
FROM awscc.detective.organization_admins_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new organization_admin resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.detective.organization_admins (
  AccountId,
  region
)
SELECT
  '{{ account_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.detective.organization_admins (
  AccountId,
  region
)
SELECT
  '{{ account_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: organization_admin
  props:
    - name: account_id
      value: '{{ account_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.detective.organization_admins
WHERE
  Identifier = '{{ account_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the organization_admins resource, the following permissions are required:

Create

detective:EnableOrganizationAdminAccount,
detective:ListOrganizationAdminAccount,
iam:CreateServiceLinkedRole,
organizations:RegisterDelegatedAdministrator,
organizations:DescribeOrganization,
organizations:EnableAWSServiceAccess,
organizations:ListAccounts

Read

detective:ListOrganizationAdminAccount,
organizations:DescribeOrganization

Delete

detective:DisableOrganizationAdminAccount,
detective:ListOrganizationAdminAccount,
organizations:DescribeOrganization

List

detective:ListOrganizationAdminAccount,
organizations:DescribeOrganization