account_alias
Creates, updates, deletes, gets or lists an account_alias resource.
Overview
| Name | account_alias |
| Type | Resource |
| Id | aws.iam.account_alias |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
create_account_alias | insert | AccountAlias, region | Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide. | |
delete_account_alias | delete | AccountAlias, region | Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
AccountAlias | string | The name of the account alias to delete. This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row. |
region | string | AWS region (default: us-east-1) |
INSERT examples
- create_account_alias
- Manifest
Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.
INSERT INTO aws.iam.account_alias (
AccountAlias,
region
)
SELECT
'{{ AccountAlias }}',
'{{ region }}'
;
# Description fields are for documentation purposes
- name: account_alias
props:
- name: AccountAlias
value: "{{ AccountAlias }}"
description: Required parameter for the account_alias resource.
- name: region
value: "{{ region }}"
description: Required parameter for the account_alias resource.
DELETE examples
- delete_account_alias
Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.
DELETE FROM aws.iam.account_alias
WHERE AccountAlias = '{{ AccountAlias }}' --required
AND region = '{{ region }}' --required
;