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	aws.paymentcryptography.aliases

Fields

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

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AliasName, 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 aliases in a region.

SELECT
region,
alias_name,
key_arn
FROM aws.paymentcryptography.aliases
WHERE region = 'us-east-1';

Gets all properties from an individual alias.

SELECT
region,
alias_name,
key_arn
FROM aws.paymentcryptography.aliases
WHERE region = 'us-east-1' AND data__Identifier = '<AliasName>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

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

DELETE example

/*+ delete */
DELETE FROM aws.paymentcryptography.aliases
WHERE data__Identifier = '<AliasName>'
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