Skip to content

CloudFormation  >  Operations  >  register_publisher

register_publisher

Operation

register_publisher async

register_publisher(request: RegisterPublisherInput | RegisterPublisherInputDict, /, *, plugins: list[Plugin] | None = None) -> RegisterPublisherOutput
register_publisher(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RegisterPublisherInputDict]) -> RegisterPublisherOutput

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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
RegisterPublisherOutput

An instance of RegisterPublisherOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

RegisterPublisherInput dataclass

Bases: _SerdeShape

Dataclass for RegisterPublisherInput structure.

Attributes
accept_terms_and_conditions class-attribute instance-attribute
accept_terms_and_conditions: bool | None = ...

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.

connection_arn class-attribute instance-attribute
connection_arn: str | None = ...

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.

Dictionaries

RegisterPublisherInputDict

Bases: TypedDict

Dictionary form of RegisterPublisherInput.

Attributes
accept_terms_and_conditions instance-attribute
accept_terms_and_conditions: bool | None

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.

connection_arn instance-attribute
connection_arn: str | None

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.

Output

RegisterPublisherOutput dataclass

Bases: _SerdeShape

Dataclass for RegisterPublisherOutput structure.

Attributes

publisher_id class-attribute instance-attribute
publisher_id: str | None = ...

The ID assigned this account by CloudFormation for publishing extensions.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.