PublishType - AWS CloudFormation

PublishType

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 on 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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Arn

The Amazon Resource Number (ARN) of the extension.

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+

Required: No

PublicVersionNumber

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 do not specify a version number, CloudFormation increments the version number by one minor version release.

The first time you publish a type, AWS CloudFormation sets the version number to 1.0.0, regardless of the value you specify.

Type: String

Length Constraints: Minimum length of 5.

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$

Required: No

Type

The type of the extension.

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

Type: String

Valid Values: RESOURCE | MODULE

Required: No

TypeName

The name of the extension.

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 204.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}

Required: No

Response Elements

The following element is returned by the service.

PublicTypeArn

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+

Errors

For information about the errors that are common to all actions, see Common Errors.

CFNRegistry

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

TypeNotFound

The specified extension does not exist in the CloudFormation registry.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: