public_type_versions

Creates, updates, deletes or gets a public_type_version resource or lists public_type_versions in a region

Overview

Name	public_type_versions
Type	Resource
Description	Test and Publish a resource that has been registered in the CloudFormation Registry.
Id	aws.cloudformation.public_type_versions

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Number (ARN) of the extension.
type_version_arn	string	The Amazon Resource Number (ARN) of the extension with the versionId.
public_version_number	string	The version number of a public third-party extension
publisher_id	string	The publisher id assigned by CloudFormation for publishing in this region.
public_type_arn	string	The Amazon Resource Number (ARN) assigned to the public extension upon publication
type_name	string	The name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
log_delivery_bucket	string	A url to the S3 bucket where logs for the testType run will be available
type	string	The kind of extension
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all public_type_versions in a region.

SELECT
region,
arn,
type_version_arn,
public_version_number,
publisher_id,
public_type_arn,
type_name,
log_delivery_bucket,
type
FROM aws.cloudformation.public_type_versions
WHERE region = 'us-east-1';

Gets all properties from an individual public_type_version.

SELECT
region,
arn,
type_version_arn,
public_version_number,
publisher_id,
public_type_arn,
type_name,
log_delivery_bucket,
type
FROM aws.cloudformation.public_type_versions
WHERE region = 'us-east-1' AND data__Identifier = '<PublicTypeArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cloudformation.public_type_versions (
 Arn,
 PublicVersionNumber,
 TypeName,
 LogDeliveryBucket,
 Type,
 region
)
SELECT 
'{{ Arn }}',
 '{{ PublicVersionNumber }}',
 '{{ TypeName }}',
 '{{ LogDeliveryBucket }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudformation.public_type_versions (
 Arn,
 PublicVersionNumber,
 TypeName,
 LogDeliveryBucket,
 Type,
 region
)
SELECT 
 '{{ Arn }}',
 '{{ PublicVersionNumber }}',
 '{{ TypeName }}',
 '{{ LogDeliveryBucket }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: public_type_version
    props:
      - name: Arn
        value: '{{ Arn }}'
      - name: PublicVersionNumber
        value: '{{ PublicVersionNumber }}'
      - name: TypeName
        value: '{{ TypeName }}'
      - name: LogDeliveryBucket
        value: '{{ LogDeliveryBucket }}'
      - name: Type
        value: '{{ Type }}'

Permissions

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

Create

cloudformation:TestType,
cloudformation:DescribeType,
cloudformation:PublishType,
cloudformation:DescribePublisher,
s3:GetObject,
s3:PutObject

Read

cloudformation:DescribeType,
cloudformation:DescribePublisher

List

cloudformation:ListTypes