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	awscc.cloudformation.public_type_versions

Fields

get (all properties)

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 reserved publisher id for this type, or 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.<br />We recommend that type names adhere to the following pattern: company&#95;or&#95;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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Number (ARN) of the extension.
public_type_arn	string	The Amazon Resource Number (ARN) assigned to the public extension upon publication
type	string	The kind of extension
region	string	AWS region.

For more information, see AWS::CloudFormation::PublicTypeVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	public_type_versions	INSERT	region
list_resources	public_type_versions_list_only	SELECT	region
get_resource	public_type_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.cloudformation.public_type_versions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ public_type_arn }}';

list (identifiers only)

Lists all public_type_versions in a region.

SELECT
  region,
  public_type_arn
FROM awscc.cloudformation.public_type_versions_list_only
WHERE
  region = 'us-east-1';

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 awscc.cloudformation.public_type_versions (
  Arn,
  PublicVersionNumber,
  TypeName,
  LogDeliveryBucket,
  Type,
  region
)
SELECT
  '{{ arn }}',
  '{{ public_version_number }}',
  '{{ type_name }}',
  '{{ log_delivery_bucket }}',
  '{{ type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.public_type_versions (
  Arn,
  PublicVersionNumber,
  TypeName,
  LogDeliveryBucket,
  Type,
  region
)
SELECT
  '{{ arn }}',
  '{{ public_version_number }}',
  '{{ type_name }}',
  '{{ log_delivery_bucket }}',
  '{{ 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: public_version_number
        value: '{{ public_version_number }}'
      - name: type_name
        value: '{{ type_name }}'
      - name: log_delivery_bucket
        value: '{{ log_delivery_bucket }}'
      - 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