View a markdown version of this page

AWS::BedrockAgentCore::PaymentManager - AWS CloudFormation
SyntaxPropertiesReturn values

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::BedrockAgentCore::PaymentManager

Specifies a payment manager for Amazon Bedrock AgentCore. A payment manager configures authorization and AWS Identity and Access Management (IAM) role settings that govern payment operations performed by AI agents, including inbound request authentication through JSON Web Token (JWT) or IAM-based authorizers.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

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

JSON

{
  "Type" : "AWS::BedrockAgentCore::PaymentManager",
  "Properties" : {
      "AuthorizerConfiguration" : AuthorizerConfiguration,
      "AuthorizerType" : String,
      "Description" : String,
      "Name" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::BedrockAgentCore::PaymentManager
Properties:
  AuthorizerConfiguration: 
    AuthorizerConfiguration
  AuthorizerType: String
  Description: String
  Name: String
  RoleArn: String
  Tags: 
    - Tag

Properties

AuthorizerConfiguration

Represents inbound authorization configuration options used to authenticate incoming requests.

Required: No

Type: AuthorizerConfiguration

Update requires: Replacement

AuthorizerType

The type of authorizer used to authenticate inbound requests to the payment manager. Valid values are CUSTOM_JWT and AWS_IAM.

Required: Yes

Type: String

Allowed values: CUSTOM_JWT | AWS_IAM

Update requires: Replacement

Description

A description of the payment manager.

Required: No

Type: String

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

Minimum: 1

Maximum: 4096

Update requires: No interruption

Name

The name of the payment manager.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9]{0,47}$

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that the payment manager assumes to perform operations on your behalf.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 2048

Update requires: No interruption

Tags

The tags for the payment manager.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the payment manager. For example:

arn:aws:bedrock-agentcore:us-east-1:123456789012:payment-manager/MyPaymentManager-a1b2c3d4e5

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 timestamp when the payment manager was created.

LastUpdatedAt

The timestamp when the payment manager was last updated.

PaymentManagerArn

The Amazon Resource Name (ARN) of the payment manager.

PaymentManagerId

The unique identifier of the payment manager.

Status

The current status of the payment manager.