account_aliases
Creates, updates, deletes or gets an account_alias
resource or lists account_aliases
in a region
Overview
Name | account_aliases |
Type | Resource |
Description | An AWS Support App resource that creates, updates, reads, and deletes a customer's account alias. |
Id | aws.supportapp.account_aliases |
Fields
Name | Datatype | Description |
---|---|---|
account_alias | string | An account alias associated with a customer's account. |
account_alias_resource_id | string | Unique identifier representing an alias tied to an account |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
create_resource | INSERT | AccountAlias, 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 account_aliases
in a region.
SELECT
region,
account_alias,
account_alias_resource_id
FROM aws.supportapp.account_aliases
WHERE region = 'us-east-1';
Gets all properties from an individual account_alias
.
SELECT
region,
account_alias,
account_alias_resource_id
FROM aws.supportapp.account_aliases
WHERE region = 'us-east-1' AND data__Identifier = '<AccountAliasResourceId>';
INSERT
example
Use the following StackQL query and manifest file to create a new account_alias
resource, using stack-deploy
.
- Required Properties
- All Properties
- Manifest
/*+ create */
INSERT INTO aws.supportapp.account_aliases (
AccountAlias,
region
)
SELECT
'{{ AccountAlias }}',
'{{ region }}';
/*+ create */
INSERT INTO aws.supportapp.account_aliases (
AccountAlias,
region
)
SELECT
'{{ AccountAlias }}',
'{{ region }}';
version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
value: '{{ vars.AWS_REGION }}'
resources:
- name: account_alias
props:
- name: AccountAlias
value: '{{ AccountAlias }}'
DELETE
example
/*+ delete */
DELETE FROM aws.supportapp.account_aliases
WHERE data__Identifier = '<AccountAliasResourceId>'
AND region = 'us-east-1';
Permissions
To operate on the account_aliases
resource, the following permissions are required:
Create
supportapp:PutAccountAlias,
supportapp:GetAccountAlias
Read
supportapp:GetAccountAlias
Update
supportapp:PutAccountAlias,
supportapp:GetAccountAlias
Delete
supportapp:DeleteAccountAlias,
supportapp:GetAccountAlias
List
supportapp:GetAccountAlias