publish-type¶

Description¶

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide .

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher .

Synopsis¶

  publish-type
[--type <value>]
[--arn <value>]
[--type-name <value>]
[--public-version-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--type (string)

The type of the extension.

Conditional: You must specify Arn , or TypeName and Type .

Possible values:

RESOURCE

MODULE

HOOK

--arn (string)

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn , or TypeName and Type .

--type-name (string)

The name of the extension.

Conditional: You must specify Arn , or TypeName and Type .

--public-version-number (string)

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0 .

If you don’t specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To publish an extension

The following publish-type example publishes the specified extension to the CloudFormation registry as a public extension in this Region.

aws cloudformation publish-type \
  --region us-west-2 \
  --type RESOURCE \
  --type-name Example::Test::1234567890abcdef0

Output:

{
    "PublicTypeArn":"arn:aws:cloudformation:us-west-2::type/resource/000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c/Example-Test-1234567890abcdef0/1.0.0"
}

For more information, see Using the AWS CloudFormation registry in the AWS CloudFormation User Guide.

Output¶

PublicTypeArn -> (string)

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

Table of Contents

Feedback

User Guide