partner_accounts

Creates, updates, deletes or gets a partner_account resource or lists partner_accounts in a region

Overview

Name	partner_accounts
Type	Resource
Description	Create and manage partner account
Id	aws.iotwireless.partner_accounts

Fields

Name	Datatype	Description
sidewalk	object	The Sidewalk account credentials.
partner_account_id	string	The partner account ID to disassociate from the AWS account
partner_type	string	The partner type
sidewalk_response	object	The Sidewalk account credentials.
account_linked	boolean	Whether the partner account is linked to the AWS account.
sidewalk_update	object	The Sidewalk account credentials.
fingerprint	string	The fingerprint of the Sidewalk application server private key.
arn	string	PartnerAccount arn. Returned after successful create.
tags	array	A list of key-value pairs that contain metadata for the destination.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all partner_accounts in a region.

SELECT
region,
sidewalk,
partner_account_id,
partner_type,
sidewalk_response,
account_linked,
sidewalk_update,
fingerprint,
arn,
tags
FROM aws.iotwireless.partner_accounts
WHERE region = 'us-east-1';

Gets all properties from an individual partner_account.

SELECT
region,
sidewalk,
partner_account_id,
partner_type,
sidewalk_response,
account_linked,
sidewalk_update,
fingerprint,
arn,
tags
FROM aws.iotwireless.partner_accounts
WHERE region = 'us-east-1' AND data__Identifier = '<PartnerAccountId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotwireless.partner_accounts (
 Sidewalk,
 PartnerAccountId,
 PartnerType,
 SidewalkResponse,
 AccountLinked,
 SidewalkUpdate,
 Tags,
 region
)
SELECT 
'{{ Sidewalk }}',
 '{{ PartnerAccountId }}',
 '{{ PartnerType }}',
 '{{ SidewalkResponse }}',
 '{{ AccountLinked }}',
 '{{ SidewalkUpdate }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotwireless.partner_accounts (
 Sidewalk,
 PartnerAccountId,
 PartnerType,
 SidewalkResponse,
 AccountLinked,
 SidewalkUpdate,
 Tags,
 region
)
SELECT 
 '{{ Sidewalk }}',
 '{{ PartnerAccountId }}',
 '{{ PartnerType }}',
 '{{ SidewalkResponse }}',
 '{{ AccountLinked }}',
 '{{ SidewalkUpdate }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: partner_account
    props:
      - name: Sidewalk
        value:
          AppServerPrivateKey: '{{ AppServerPrivateKey }}'
      - name: PartnerAccountId
        value: '{{ PartnerAccountId }}'
      - name: PartnerType
        value: '{{ PartnerType }}'
      - name: SidewalkResponse
        value:
          AmazonId: '{{ AmazonId }}'
          Fingerprint: '{{ Fingerprint }}'
          Arn: '{{ Arn }}'
      - name: AccountLinked
        value: '{{ AccountLinked }}'
      - name: SidewalkUpdate
        value:
          AppServerPrivateKey: '{{ AppServerPrivateKey }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotwireless.partner_accounts
WHERE data__Identifier = '<PartnerAccountId>'
AND region = 'us-east-1';

Permissions

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

Create

iotwireless:AssociateAwsAccountWithPartnerAccount,
iotwireless:TagResource,
iotwireless:ListTagsForResource

Read

iotwireless:GetPartnerAccount,
iotwireless:ListTagsForResource

List

iotwireless:ListPartnerAccounts,
iotwireless:ListTagsForResource

Update

iotwireless:UpdatePartnerAccount,
iotwireless:UntagResource,
iotwireless:ListTagsForResource

Delete

iotwireless:DisassociateAwsAccountFromPartnerAccount