billing_groups

Creates, updates, deletes or gets a billing_group resource or lists billing_groups in a region

Overview

Name	billing_groups
Type	Resource
Description	A billing group is a set of linked account which belong to the same end customer. It can be seen as a virtual consolidated billing family.
Id	awscc.billingconductor.billing_groups

Fields

get (all properties)

Name	Datatype	Description
arn	string	Billing Group ARN
name	string
description	string
primary_account_id	string	This account will act as a virtual payer account of the billing group
▶computation_preference	object
▶account_grouping	object
size	integer	Number of accounts in the billing group
status	string
status_reason	string
creation_time	integer	Creation timestamp in UNIX epoch time format
last_modified_time	integer	Latest modified timestamp in UNIX epoch time format
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Billing Group ARN
region	string	AWS region.

For more information, see AWS::BillingConductor::BillingGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	billing_groups	INSERT	Name, AccountGrouping, PrimaryAccountId, ComputationPreference, region
delete_resource	billing_groups	DELETE	Identifier, region
update_resource	billing_groups	UPDATE	Identifier, PatchDocument, region
list_resources	billing_groups_list_only	SELECT	region
get_resource	billing_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual billing_group.

SELECT
  region,
  arn,
  name,
  description,
  primary_account_id,
  computation_preference,
  account_grouping,
  size,
  status,
  status_reason,
  creation_time,
  last_modified_time,
  tags
FROM awscc.billingconductor.billing_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all billing_groups in a region.

SELECT
  region,
  arn
FROM awscc.billingconductor.billing_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.billingconductor.billing_groups (
  Name,
  PrimaryAccountId,
  ComputationPreference,
  AccountGrouping,
  region
)
SELECT
  '{{ name }}',
  '{{ primary_account_id }}',
  '{{ computation_preference }}',
  '{{ account_grouping }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.billingconductor.billing_groups (
  Name,
  Description,
  PrimaryAccountId,
  ComputationPreference,
  AccountGrouping,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ primary_account_id }}',
  '{{ computation_preference }}',
  '{{ account_grouping }}',
  '{{ tags }}',
  '{{ 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: billing_group
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: primary_account_id
      value: '{{ primary_account_id }}'
    - name: computation_preference
      value:
        pricing_plan_arn: '{{ pricing_plan_arn }}'
    - name: account_grouping
      value:
        linked_account_ids:
          - '{{ linked_account_ids[0] }}'
        auto_associate: '{{ auto_associate }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a billing_group resource, using stack-deploy.

/*+ update */
UPDATE awscc.billingconductor.billing_groups
SET PatchDocument = string('{{ {
    "Name": name,
    "Description": description,
    "ComputationPreference": computation_preference,
    "AccountGrouping": account_grouping,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.billingconductor.billing_groups
WHERE
  Identifier = '{{ arn }}' 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 billing_groups resource, the following permissions are required:

Create

billingconductor:CreateBillingGroup,
billingconductor:AssociateAccounts,
billingconductor:ListBillingGroups,
billingconductor:TagResource,
billingconductor:ListTagsForResource

Read

billingconductor:ListBillingGroups,
billingconductor:ListAccountAssociations,
organizations:ListAccounts,
billingconductor:ListTagsForResource

List

billingconductor:ListBillingGroups,
billingconductor:ListAccountAssociations,
organizations:ListAccounts,
billingconductor:ListTagsForResource

Update

billingconductor:UpdateBillingGroup,
billingconductor:ListAccountAssociations,
organizations:ListAccounts,
billingconductor:AssociateAccounts,
billingconductor:DisassociateAccounts,
billingconductor:ListBillingGroups,
billingconductor:TagResource,
billingconductor:UntagResource

Delete

billingconductor:DeleteBillingGroup,
billingconductor:ListBillingGroups,
billingconductor:UntagResource,
billingconductor:UpdateBillingGroup