AgentcoreGatewayState class
Input properties used for looking up and filtering AgentcoreGateway resources.
Constructors
-
AgentcoreGatewayState({Input<
AgentcoreGatewayAuthorizerConfiguration?> ? authorizerConfiguration, Input<String?> ? authorizerType, Input<String?> ? description, Input<String?> ? exceptionLevel, Input<String?> ? gatewayArn, Input<String?> ? gatewayId, Input<String?> ? gatewayUrl, Input<List< ? interceptorConfigurations, Input<AgentcoreGatewayInterceptorConfiguration> ?>String?> ? kmsKeyArn, Input<String?> ? name, Input<AgentcoreGatewayPolicyEngineConfiguration?> ? policyEngineConfiguration, Input<AgentcoreGatewayProtocolConfiguration?> ? protocolConfiguration, Input<String?> ? protocolType, Input<String?> ? region, Input<String?> ? roleArn, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>AgentcoreGatewayTimeouts?> ? timeouts, Input<List< ? workloadIdentityDetails})AgentcoreGatewayWorkloadIdentityDetail> ?> -
Creates a new AgentcoreGatewayState.
authorizerConfigurationConfiguration for request authorization. Required whenauthorizerTypeis set toCUSTOM_JWT. SeeauthorizerConfigurationbelow.authorizerTypeType of authorizer to use. Valid values:CUSTOM_JWT,AWS_IAM. When set toCUSTOM_JWT,authorizerConfigurationblock is required.descriptionDescription of the gateway.exceptionLevelException level for the gateway. Valid values:DEBUG.gatewayArnARN of the Gateway.gatewayIdUnique identifier of the Gateway.gatewayUrlURL endpoint for the gateway.interceptorConfigurationsList of interceptor configurations for the gateway. Minimum of 1, maximum of 2. SeeinterceptorConfigurationbelow.kmsKeyArnARN of the KMS key used to encrypt the gateway data.nameName of the gateway.policyEngineConfigurationConfiguration for a policy engine associated with the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. SeepolicyEngineConfigurationbelow.protocolConfigurationProtocol-specific configuration for the gateway. SeeprotocolConfigurationbelow.protocolTypeProtocol type for the gateway. Valid values:MCP. Omit this argument to create a gateway that routes traffic directly to HTTP targets such as AgentCore Runtime agents (seeaws.bedrock.AgentcoreGatewayTargettarget_configuration.http).regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnARN of the IAM role that the gateway assumes to access AWS services.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.timeoutsOptional.workloadIdentityDetailsWorkload identity details for the gateway. SeeworkloadIdentityDetailsbelow.const -
AgentcoreGatewayState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
Configuration for request authorization. Required when
authorizerTypeis set toCUSTOM_JWT. SeeauthorizerConfigurationbelow.final -
Type of authorizer to use. Valid values:
CUSTOM_JWT,AWS_IAM. When set toCUSTOM_JWT,authorizerConfigurationblock is required.final -
description
→ Input<
String?> ? -
Description of the gateway.
final
-
exceptionLevel
→ Input<
String?> ? -
Exception level for the gateway. Valid values:
DEBUG.final -
gatewayArn
→ Input<
String?> ? -
ARN of the Gateway.
final
-
gatewayId
→ Input<
String?> ? -
Unique identifier of the Gateway.
final
-
gatewayUrl
→ Input<
String?> ? -
URL endpoint for the gateway.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
interceptorConfigurations
→ Input<
List< ?AgentcoreGatewayInterceptorConfiguration> ?> -
List of interceptor configurations for the gateway. Minimum of 1, maximum of 2. See
interceptorConfigurationbelow.final -
kmsKeyArn
→ Input<
String?> ? -
ARN of the KMS key used to encrypt the gateway data.
final
-
name
→ Input<
String?> ? -
Name of the gateway.
final
-
policyEngineConfiguration
→ Input<
AgentcoreGatewayPolicyEngineConfiguration?> ? -
Configuration for a policy engine associated with the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. See
policyEngineConfigurationbelow.final -
protocolConfiguration
→ Input<
AgentcoreGatewayProtocolConfiguration?> ? -
Protocol-specific configuration for the gateway. See
protocolConfigurationbelow.final -
protocolType
→ Input<
String?> ? -
Protocol type for the gateway. Valid values:
MCP. Omit this argument to create a gateway that routes traffic directly to HTTP targets such as AgentCore Runtime agents (seeaws.bedrock.AgentcoreGatewayTargettarget_configuration.http).final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
roleArn
→ Input<
String?> ? -
ARN of the IAM role that the gateway assumes to access AWS services.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
timeouts
→ Input<
AgentcoreGatewayTimeouts?> ? -
final
-
workloadIdentityDetails
→ Input<
List< ?AgentcoreGatewayWorkloadIdentityDetail> ?> -
Workload identity details for the gateway. See
workloadIdentityDetailsbelow.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited