interface GatewayIamRoleCredentialProviderProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.BedrockAgentCore.GatewayIamRoleCredentialProviderProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#GatewayIamRoleCredentialProviderProps |
 Java | software.amazon.awscdk.services.bedrockagentcore.GatewayIamRoleCredentialProviderProps |
 Python | aws_cdk.aws_bedrockagentcore.GatewayIamRoleCredentialProviderProps |
 TypeScript (source) | aws-cdk-lib » aws_bedrockagentcore » GatewayIamRoleCredentialProviderProps |
Properties for configuring the IAM role credential provider.
When a target is authenticated via the gateway's execution role, the gateway signs outbound requests with SigV4. These properties let you tell the gateway which AWS service and region to sign for, instead of letting it infer them from the target endpoint.
Example
agentcore.GatewayCredentialProvider.fromIamRole({
service: 'bedrock-runtime', // SigV4 signing name (typically the endpoint prefix); see the AWS service authorization reference
region: 'us-east-1', // defaults to the gateway's region
});
Properties
| Name | Type | Description |
|---|---|---|
| region? | string | The AWS Region used for SigV4 signing of outbound requests. Can be up to 32 characters long. |
| service? | string | The AWS service name used for SigV4 signing of outbound requests. |
region?
Type:
string
(optional, default: Gateway's own Region)
The AWS Region used for SigV4 signing of outbound requests. Can be up to 32 characters long.
Pattern: ^[a-zA-Z0-9-]+$
service?
Type:
string
(optional, default: Gateway infers the service from the target endpoint)
The AWS service name used for SigV4 signing of outbound requests.
Use the SigV4 signing name (typically the endpoint prefix), e.g.
bedrock-runtime, s3, execute-api, dynamodb.
Can be up to 64 characters long.
Pattern: ^[a-zA-Z0-9._-]+$