View a markdown version of this page

AWS::AgentRegistry::RegistryRecord RegistryRecordIamCredentialProvider - AWS CloudFormation
SyntaxProperties

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::RegistryRecord RegistryRecordIamCredentialProvider

The configuration for an IAM role credential provider that signs requests to a registry record's source with AWS Signature Version 4 (SigV4).

Syntax

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

JSON

{
  "Region" : String,
  "RoleArn" : String,
  "Service" : String
}

YAML

  Region: String
  RoleArn: String
  Service: String

Properties

Region

The AWS Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.

Required: No

Type: String

Pattern: ^[a-z0-9-]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) of the IAM role to assume for request signing.

Required: No

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$

Minimum: 20

Maximum: 2048

Update requires: No interruption

Service

The service name to use for request signing, such as execute-api.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 128

Update requires: No interruption