publishers

Creates, updates, deletes or gets a publisher resource or lists publishers in a region

Overview

Name	publishers
Type	Resource
Description	Register as a publisher in the CloudFormation Registry.
Id	awscc.cloudformation.publishers

Fields

get (all properties)

Name	Datatype	Description
accept_terms_and_conditions	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 publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
publisher_id	string	The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
connection_arn	string	If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
publisher_status	string	Whether the publisher is verified.
publisher_profile	string	The URL to the publisher's profile with the identity provider.
identity_provider	string	The type of account used as the identity provider when registering this publisher with CloudFormation.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
publisher_id	string	The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	publishers	INSERT	AcceptTermsAndConditions, region
list_resources	publishers_list_only	SELECT	region
get_resource	publishers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual publisher.

SELECT
  region,
  accept_terms_and_conditions,
  publisher_id,
  connection_arn,
  publisher_status,
  publisher_profile,
  identity_provider
FROM awscc.cloudformation.publishers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ publisher_id }}';

list (identifiers only)

Lists all publishers in a region.

SELECT
  region,
  publisher_id
FROM awscc.cloudformation.publishers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.cloudformation.publishers (
  AcceptTermsAndConditions,
  region
)
SELECT
  '{{ accept_terms_and_conditions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.publishers (
  AcceptTermsAndConditions,
  ConnectionArn,
  region
)
SELECT
  '{{ accept_terms_and_conditions }}',
  '{{ connection_arn }}',
  '{{ 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: publisher
  props:
    - name: accept_terms_and_conditions
      value: '{{ accept_terms_and_conditions }}'
    - name: connection_arn
      value: '{{ connection_arn }}'

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 publishers resource, the following permissions are required:

Create

cloudformation:RegisterPublisher,
cloudformation:DescribePublisher,
codestar-connections:GetConnection,
codestar-connections:UseConnection

Read

cloudformation:DescribePublisher

List

cloudformation:DescribePublisher