CloudFormation / Client / publish_type

publish_type#

CloudFormation.Client.publish_type(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.publish_type(
    Type='RESOURCE'|'MODULE'|'HOOK',
    Arn='string',
    TypeName='string',
    PublicVersionNumber='string'
)
Parameters:

  • Type (string) –

    The type of the extension.

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

  • Arn (string) –

    The Amazon Resource Name (ARN) of the extension.

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

  • TypeName (string) –

    The name of the extension.

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

  • PublicVersionNumber (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.

Return type:

dict

Returns:

Response Syntax

{
    'PublicTypeArn': 'string'
}

Response Structure

  • (dict) –

    • PublicTypeArn (string) –

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

Exceptions