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	awscc.ivs.public_keys

Fields

get (all properties)

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. This field is required to create the AWS::IVS::PublicKey resource.
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.

list (identifiers only)

Name	Datatype	Description
arn	string	Key-pair identifier.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	public_keys	INSERT	region
delete_resource	public_keys	DELETE	Identifier, region
update_resource	public_keys	UPDATE	Identifier, PatchDocument, region
list_resources	public_keys_list_only	SELECT	region
get_resource	public_keys	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual public_key.

SELECT
  region,
  name,
  public_key_material,
  fingerprint,
  arn,
  tags
FROM awscc.ivs.public_keys
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all public_keys in a region.

SELECT
  region,
  arn
FROM awscc.ivs.public_keys_list_only
WHERE
  region = '{{ region }}';

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 awscc.ivs.public_keys (
  Name,
  PublicKeyMaterial,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ public_key_material }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.public_keys (
  Name,
  PublicKeyMaterial,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ public_key_material }}',
  '{{ tags }}',
  '{{ 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: public_key
  props:
    - name: name
      value: '{{ name }}'
    - name: public_key_material
      value: '{{ public_key_material }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.public_keys
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.public_keys
WHERE
  Identifier = '{{ arn }}' 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 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