aliases

Creates, updates, deletes or gets an alias resource or lists aliases in a region

Overview

Name	aliases
Type	Resource
Description	Definition of AWS::PaymentCryptography::Alias Resource Type
Id	awscc.paymentcryptography.aliases

Fields

get (all properties)

Name	Datatype	Description
alias_name	string
key_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
alias_name	string
region	string	AWS region.

For more information, see AWS::PaymentCryptography::Alias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	aliases	INSERT	AliasName, region
delete_resource	aliases	DELETE	Identifier, region
update_resource	aliases	UPDATE	Identifier, PatchDocument, region
list_resources	aliases_list_only	SELECT	region
get_resource	aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual alias.

SELECT
  region,
  alias_name,
  key_arn
FROM awscc.paymentcryptography.aliases
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ alias_name }}';

list (identifiers only)

Lists all aliases in a region.

SELECT
  region,
  alias_name
FROM awscc.paymentcryptography.aliases_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.paymentcryptography.aliases (
  AliasName,
  region
)
SELECT
  '{{ alias_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.paymentcryptography.aliases (
  AliasName,
  KeyArn,
  region
)
SELECT
  '{{ alias_name }}',
  '{{ key_arn }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alias
    props:
      - name: alias_name
        value: '{{ alias_name }}'
      - name: key_arn
        value: '{{ key_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.paymentcryptography.aliases
SET PatchDocument = string('{{ {
    "KeyArn": key_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alias_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.paymentcryptography.aliases
WHERE
  Identifier = '{{ alias_name }}' AND
  region = 'us-east-1';

Permissions

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

Create

payment-cryptography:CreateAlias

Read

payment-cryptography:GetAlias

Update

payment-cryptography:UpdateAlias

Delete

payment-cryptography:DeleteAlias

List

payment-cryptography:ListAliases