public_keys

Creates, updates, deletes, gets or lists a public_keys resource.

Overview

Name	public_keys
Type	Resource
Id	aws.ivs_realtime.public_keys

Fields

The following fields are returned by SELECT queries:

get_public_key

Name	Datatype	Description
name	string	Public key name. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Public key ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+</code>)
fingerprint	string	The public key fingerprint, a short string used to identify or verify the full public key.
public_key_material	string	Public key material. (pattern: <code>.-----BEGIN PUBLIC KEY-----\r?\n([a-zA-Z0-9+/=\r\n]+)\r?\n-----END PUBLIC KEY-----(\r?\n)?.</code>)
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

list_public_keys

Name	Datatype	Description
name	string	Public key name. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	Public key ARN. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+</code>)
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_public_key	select	region		Gets information for the specified public key.
list_public_keys	select	region		Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
delete_public_key	delete	region		Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_public_key

Gets information for the specified public key.

SELECT
name,
arn,
fingerprint,
public_key_material,
tags
FROM aws.ivs_realtime.public_keys
WHERE region = '{{ region }}' -- required
;

list_public_keys

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

SELECT
name,
arn,
tags
FROM aws.ivs_realtime.public_keys
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_public_key

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

DELETE FROM aws.ivs_realtime.public_keys
WHERE region = '{{ region }}' --required
;