View a markdown version of this page

AWS::AgentRegistry::Publisher - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::AgentRegistry::Publisher

AWS Agent Registry lets you register and discover agents, tools, and related resources. A Publisher is a verified public identity under which your organization publishes records for public discovery. The AWS::AgentRegistry::Publisher resource specifies a publisher for a domain that you control.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::AgentRegistry::Publisher", "Properties" : { "Tags" : [ Tag, ... ], "Value" : Identifier } }

YAML

Type: AWS::AgentRegistry::Publisher Properties: Tags: - Tag Value: Identifier

Properties

Tags

A list of key-value pairs that contain metadata for the publisher. For more information, see Tagging AWS resources in the AWS General Reference Guide.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Value

The Value property specifies the publisher identifier. The only supported identifier is a domain, which you specify with the Domain property. For instructions on verifying the domain during resource creation, see Creating a Publisher with AWS CloudFormation in the AWS Agent Registry Developer Guide.

Required: Yes

Type: Identifier

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns

The Amazon Resource Name (ARN) of the publisher.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The CreatedAt attribute contains the timestamp when the publisher was created.

PublisherArn

The PublisherArn attribute contains the ARN of the publisher. The ARN does not include an AWS Region because the publisher applies across all AWS Regions.

Status

The Status attribute indicates the publisher verification state. It can have one of the following values:

  • ACTION_REQUIRED – The Publisher requires domain verification. You can retrieve the challenge through GetPublisher, and publish the returned Domain Name System (DNS) TXT record.

  • ACTIVE – Domain verification succeeded. The Publisher can accept new registry record associations.

  • FAILED – Domain verification failed. Confirm that the DNS TXT record matches the expected name and value before retrying.

  • SUSPENDED – The previously verified DNS TXT record is missing. Restore the expected record to allow domain verification to succeed again.

  • DELETING – The Publisher is being deleted.

UpdatedAt

The UpdatedAt attribute contains the timestamp when the publisher was last updated.