Package software.amazon.awscdk.services.bedrockagentcore

Interface GatewayIamRoleCredentialProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GatewayIamRoleCredentialProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-22T17:37:21.429Z")
@Stability(Stable)
public interface GatewayIamRoleCredentialProviderProps
extends software.amazon.jsii.JsiiSerializable

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:

 GatewayCredentialProvider.fromIamRole(GatewayIamRoleCredentialProviderProps.builder()
         .service("bedrock-runtime") // SigV4 signing name (typically the endpoint prefix); see the AWS service authorization reference
         .region("us-east-1")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GatewayIamRoleCredentialProviderProps.Builder	A builder for GatewayIamRoleCredentialProviderProps
static final class	GatewayIamRoleCredentialProviderProps.Jsii$Proxy	An implementation for GatewayIamRoleCredentialProviderProps

Method Summary

Modifier and Type	Method	Description
static GatewayIamRoleCredentialProviderProps.Builder	builder()
default String	getRegion()	The AWS Region used for SigV4 signing of outbound requests.
default String	getService()	The AWS service name used for SigV4 signing of outbound requests.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

The AWS Region used for SigV4 signing of outbound requests. Can be up to 32 characters long.

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

Default: - Gateway's own Region

getService

@Stability(Stable)
@Nullable
default String getService()

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._-]+$

Default: - Gateway infers the service from the target endpoint

See Also:

• https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html

builder

@Stability(Stable)
static GatewayIamRoleCredentialProviderProps.Builder builder()

Returns:

a GatewayIamRoleCredentialProviderProps.Builder of GatewayIamRoleCredentialProviderProps