publishers

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

Overview

Name	publishers
Type	Resource
Id	aws.cloudformation.publishers

Fields

The following fields are returned by SELECT queries:

describe_publisher

Name	Datatype	Description
line_items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_publisher	select	region	PublisherId	Returns information about a CloudFormation extension publisher. If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account. For more information about registering as a publisher, see: RegisterPublisher Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide
register_publisher	insert	region	AcceptTermsAndConditions, ConnectionArn	Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions. For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

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)
AcceptTermsAndConditions	boolean	Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry. The default is false.
ConnectionArn	string	If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
PublisherId	string	The ID of the extension publisher. If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

SELECT examples

describe_publisher

Returns information about a CloudFormation extension publisher. If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account. For more information about registering as a publisher, see: RegisterPublisher Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide

SELECT
line_items
FROM aws.cloudformation.publishers
WHERE region = '{{ region }}' -- required
AND PublisherId = '{{ PublisherId }}'
;

INSERT examples

register_publisher

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions. For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.

INSERT INTO aws.cloudformation.publishers (
region,
AcceptTermsAndConditions,
ConnectionArn
)
SELECT 
'{{ region }}',
'{{ AcceptTermsAndConditions }}',
'{{ ConnectionArn }}'
RETURNING
line_items
;

Manifest

# Description fields are for documentation purposes
- name: publishers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the publishers resource.
  - name: AcceptTermsAndConditions
    value: {{ AcceptTermsAndConditions }}
    description: Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry. The default is false.
    description: Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry. The default is false.
  - name: ConnectionArn
    value: "{{ ConnectionArn }}"
    description: If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
    description: If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account. For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.