invoice_units

Creates, updates, deletes or gets an invoice_unit resource or lists invoice_units in a region

Overview

Name	invoice_units
Type	Resource
Description	An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you to separate AWS account costs and configures your invoice for each business entity.
Id	awscc.invoicing.invoice_units

Fields

get (all properties)

Name	Datatype	Description
invoice_unit_arn	string
invoice_receiver	string
name	string
description	string
tax_inheritance_disabled	boolean
▶rule	object
last_modified	number
▶resource_tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
invoice_unit_arn	string
region	string	AWS region.

For more information, see AWS::Invoicing::InvoiceUnit.

Methods

Name	Resource	Accessible by	Required Params
create_resource	invoice_units	INSERT	InvoiceReceiver, Name, Rule, region
delete_resource	invoice_units	DELETE	Identifier, region
update_resource	invoice_units	UPDATE	Identifier, PatchDocument, region
list_resources	invoice_units_list_only	SELECT	region
get_resource	invoice_units	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual invoice_unit.

SELECT
  region,
  invoice_unit_arn,
  invoice_receiver,
  name,
  description,
  tax_inheritance_disabled,
  rule,
  last_modified,
  resource_tags
FROM awscc.invoicing.invoice_units
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ invoice_unit_arn }}';

list (identifiers only)

Lists all invoice_units in a region.

SELECT
  region,
  invoice_unit_arn
FROM awscc.invoicing.invoice_units_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.invoicing.invoice_units (
  InvoiceReceiver,
  Name,
  Rule,
  region
)
SELECT
  '{{ invoice_receiver }}',
  '{{ name }}',
  '{{ rule }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.invoicing.invoice_units (
  InvoiceReceiver,
  Name,
  Description,
  TaxInheritanceDisabled,
  Rule,
  ResourceTags,
  region
)
SELECT
  '{{ invoice_receiver }}',
  '{{ name }}',
  '{{ description }}',
  '{{ tax_inheritance_disabled }}',
  '{{ rule }}',
  '{{ resource_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: invoice_unit
  props:
    - name: invoice_receiver
      value: '{{ invoice_receiver }}'
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: tax_inheritance_disabled
      value: '{{ tax_inheritance_disabled }}'
    - name: rule
      value:
        linked_accounts:
          - '{{ linked_accounts[0] }}'
    - name: resource_tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.invoicing.invoice_units
SET PatchDocument = string('{{ {
    "Description": description,
    "TaxInheritanceDisabled": tax_inheritance_disabled,
    "Rule": rule,
    "ResourceTags": resource_tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ invoice_unit_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

invoicing:CreateInvoiceUnit,
invoicing:TagResource

Read

invoicing:GetInvoiceUnit,
invoicing:ListTagsForResource

Update

invoicing:UpdateInvoiceUnit,
invoicing:UntagResource,
invoicing:TagResource

Delete

invoicing:DeleteInvoiceUnit

List

invoicing:ListInvoiceUnits