public_keys

Creates, updates, deletes or gets a public_key resource or lists public_keys in a region

Overview

Name	public_keys
Type	Resource
Description	Resource Type definition for AWS::IVS::PublicKey
Id	aws.ivs.public_keys

Fields

Name	Datatype	Description
name	string	Name of the public key to be imported. The value does not need to be unique.
public_key_material	string	The public portion of a customer-generated key pair.
fingerprint	string	Key-pair identifier.
arn	string	Key-pair identifier.
tags	array	A list of key-value pairs that contain metadata for the asset model.
region	string	AWS region.

For more information, see AWS::IVS::PublicKey.

Methods

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

SELECT
region,
name,
public_key_material,
fingerprint,
arn,
tags
FROM aws.ivs.public_keys
WHERE region = 'us-east-1';

Gets all properties from an individual public_key.

SELECT
region,
name,
public_key_material,
fingerprint,
arn,
tags
FROM aws.ivs.public_keys
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ivs.public_keys (
 Name,
 PublicKeyMaterial,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ PublicKeyMaterial }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.public_keys (
 Name,
 PublicKeyMaterial,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ PublicKeyMaterial }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: public_key
    props:
      - name: Name
        value: '{{ Name }}'
      - name: PublicKeyMaterial
        value: '{{ PublicKeyMaterial }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ivs.public_keys
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

ivs:ImportPublicKey,
ivs:TagResource

Read

ivs:GetPublicKey

Update

ivs:GetPublicKey,
ivs:ListTagsForResource,
ivs:UntagResource,
ivs:TagResource

Delete

ivs:DeletePublicKey,
ivs:UntagResource

List

ivs:ListPublicKeys,
ivs:ListTagsForResource