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	awscc.supportapp.account_aliases

Fields

get (all properties)

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.

list (identifiers only)

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.

For more information, see AWS::SupportApp::AccountAlias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	account_aliases	INSERT	AccountAlias, region
delete_resource	account_aliases	DELETE	Identifier, region
update_resource	account_aliases	UPDATE	Identifier, PatchDocument, region
list_resources	account_aliases_list_only	SELECT	region
get_resource	account_aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual account_alias.

SELECT
  region,
  account_alias,
  account_alias_resource_id
FROM awscc.supportapp.account_aliases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_alias_resource_id }}';

list (identifiers only)

Lists all account_aliases in a region.

SELECT
  region,
  account_alias_resource_id
FROM awscc.supportapp.account_aliases_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.supportapp.account_aliases (
  AccountAlias,
  region
)
SELECT
  '{{ account_alias }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.supportapp.account_aliases (
  AccountAlias,
  region
)
SELECT
  '{{ account_alias }}',
  '{{ 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: account_alias
  props:
    - name: account_alias
      value: '{{ account_alias }}'

UPDATE example

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

/*+ update */
UPDATE awscc.supportapp.account_aliases
SET PatchDocument = string('{{ {
    "AccountAlias": account_alias
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_alias_resource_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.supportapp.account_aliases
WHERE
  Identifier = '{{ account_alias_resource_id }}' 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 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