CfnGatewayPropsMixin
- class aws_cdk.cfn_property_mixins.aws_bedrockagentcore.CfnGatewayPropsMixin(props, *, strategy=None)
Bases:
MixinAmazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.
For more information about creating a gateway, see Set up an Amazon Bedrock AgentCore gateway .
See the Properties section below for descriptions of both the required and optional properties.
- See:
- CloudformationResource:
AWS::BedrockAgentCore::Gateway
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_gateway_props_mixin = bedrockagentcore.CfnGatewayPropsMixin(bedrockagentcore.CfnGatewayMixinProps( authorizer_configuration=bedrockagentcore.CfnGatewayPropsMixin.AuthorizerConfigurationProperty( custom_jwt_authorizer=bedrockagentcore.CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty( advertised_scope_mapping={ "advertised_scope_mapping_key": "advertisedScopeMapping" }, allowed_audience=["allowedAudience"], allowed_clients=["allowedClients"], allowed_scopes=["allowedScopes"], custom_claims=[bedrockagentcore.CfnGatewayPropsMixin.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore.CfnGatewayPropsMixin.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore.CfnGatewayPropsMixin.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] ) ), inbound_token_claim_name="inboundTokenClaimName", inbound_token_claim_value_type="inboundTokenClaimValueType" )], discovery_url="discoveryUrl", private_endpoint=bedrockagentcore.CfnGatewayPropsMixin.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnGatewayPropsMixin.ManagedVpcResourceProperty( endpoint_ip_address_type="endpointIpAddressType", routing_domain="routingDomain", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], vpc_identifier="vpcIdentifier" ), self_managed_lattice_resource=bedrockagentcore.CfnGatewayPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) ) ) ), authorizer_type="authorizerType", description="description", exception_level="exceptionLevel", interceptor_configurations=[bedrockagentcore.CfnGatewayPropsMixin.GatewayInterceptorConfigurationProperty( input_configuration=bedrockagentcore.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False, payload_filter=bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadFilterProperty( exclude=[bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty( field="field" )] ) ), interception_points=["interceptionPoints"], interceptor=bedrockagentcore.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) ) )], kms_key_arn="kmsKeyArn", name="name", policy_engine_configuration=bedrockagentcore.CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty( arn="arn", mode="mode" ), protocol_configuration=bedrockagentcore.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty( mcp=bedrockagentcore.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", session_configuration=bedrockagentcore.CfnGatewayPropsMixin.SessionConfigurationProperty( session_timeout_in_seconds=123 ), streaming_configuration=bedrockagentcore.CfnGatewayPropsMixin.StreamingConfigurationProperty( enable_response_streaming=False ), supported_versions=["supportedVersions"] ) ), protocol_type="protocolType", role_arn="roleArn", tags={ "tags_key": "tags" }, waf_configuration=bedrockagentcore.CfnGatewayPropsMixin.WafConfigurationProperty( failure_mode="failureMode" ) ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::BedrockAgentCore::Gateway.- Parameters:
props (
Union[CfnGatewayMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['authorizerConfiguration', 'authorizerType', 'description', 'exceptionLevel', 'interceptorConfigurations', 'kmsKeyArn', 'name', 'policyEngineConfiguration', 'protocolConfiguration', 'protocolType', 'roleArn', 'tags', 'wafConfiguration']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
ClaimMatchValueTypeProperty
- class CfnGatewayPropsMixin.ClaimMatchValueTypeProperty(*, match_value_string=None, match_value_string_list=None)
Bases:
object- Parameters:
match_value_string (
Optional[str])match_value_string_list (
Optional[Sequence[str]])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore claim_match_value_type_property = bedrockagentcore.CfnGatewayPropsMixin.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] )
Attributes
- match_value_string
-
- Type:
see
CustomClaimValidationTypeProperty
- class CfnGatewayPropsMixin.CustomClaimValidationTypeProperty(*, authorizing_claim_match_value=None, inbound_token_claim_name=None, inbound_token_claim_value_type=None)
Bases:
object- Parameters:
authorizing_claim_match_value (
Union[IResolvable,AuthorizingClaimMatchValueTypeProperty,Dict[str,Any],None])inbound_token_claim_name (
Optional[str])inbound_token_claim_value_type (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore custom_claim_validation_type_property = bedrockagentcore.CfnGatewayPropsMixin.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore.CfnGatewayPropsMixin.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore.CfnGatewayPropsMixin.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] ) ), inbound_token_claim_name="inboundTokenClaimName", inbound_token_claim_value_type="inboundTokenClaimValueType" )
Attributes
- authorizing_claim_match_value
-
- Type:
see
- inbound_token_claim_name
-
- Type:
see
GatewayInterceptorConfigurationProperty
- class CfnGatewayPropsMixin.GatewayInterceptorConfigurationProperty(*, input_configuration=None, interception_points=None, interceptor=None)
Bases:
object- Parameters:
input_configuration (
Union[IResolvable,InterceptorInputConfigurationProperty,Dict[str,Any],None])interception_points (
Optional[Sequence[str]])interceptor (
Union[IResolvable,InterceptorConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore gateway_interceptor_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.GatewayInterceptorConfigurationProperty( input_configuration=bedrockagentcore.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False, payload_filter=bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadFilterProperty( exclude=[bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty( field="field" )] ) ), interception_points=["interceptionPoints"], interceptor=bedrockagentcore.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) ) )
Attributes
- input_configuration
-
- Type:
see
- interception_points
-
- Type:
see
GatewayPolicyEngineConfigurationProperty
- class CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty(*, arn=None, mode=None)
Bases:
object- Parameters:
arn (
Optional[str])mode (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore gateway_policy_engine_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.GatewayPolicyEngineConfigurationProperty( arn="arn", mode="mode" )
Attributes
- arn
-
- Type:
see
GatewayProtocolConfigurationProperty
- class CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty(*, mcp=None)
Bases:
objectThe protocol configuration.
- Parameters:
mcp (
Union[IResolvable,MCPGatewayConfigurationProperty,Dict[str,Any],None]) – The gateway protocol configuration for MCP.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore gateway_protocol_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty( mcp=bedrockagentcore.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", session_configuration=bedrockagentcore.CfnGatewayPropsMixin.SessionConfigurationProperty( session_timeout_in_seconds=123 ), streaming_configuration=bedrockagentcore.CfnGatewayPropsMixin.StreamingConfigurationProperty( enable_response_streaming=False ), supported_versions=["supportedVersions"] ) )
Attributes
- mcp
The gateway protocol configuration for MCP.
InterceptorConfigurationProperty
- class CfnGatewayPropsMixin.InterceptorConfigurationProperty(*, lambda_=None)
Bases:
object- Parameters:
lambda
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore interceptor_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) )
Attributes
InterceptorInputConfigurationProperty
- class CfnGatewayPropsMixin.InterceptorInputConfigurationProperty(*, pass_request_headers=None, payload_filter=None)
Bases:
object- Parameters:
pass_request_headers (
Union[bool,IResolvable,None])payload_filter (
Union[IResolvable,InterceptorPayloadFilterProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore interceptor_input_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False, payload_filter=bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadFilterProperty( exclude=[bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty( field="field" )] ) )
Attributes
- pass_request_headers
-
- Type:
see
InterceptorPayloadExclusionSelectorProperty
- class CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty(*, field=None)
Bases:
object- Parameters:
field (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore interceptor_payload_exclusion_selector_property = bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty( field="field" )
Attributes
InterceptorPayloadFilterProperty
- class CfnGatewayPropsMixin.InterceptorPayloadFilterProperty(*, exclude=None)
Bases:
object- Parameters:
exclude (
Union[IResolvable,Sequence[Union[IResolvable,InterceptorPayloadExclusionSelectorProperty,Dict[str,Any]]],None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore interceptor_payload_filter_property = bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadFilterProperty( exclude=[bedrockagentcore.CfnGatewayPropsMixin.InterceptorPayloadExclusionSelectorProperty( field="field" )] )
Attributes
LambdaInterceptorConfigurationProperty
- class CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty(*, arn=None)
Bases:
object- Parameters:
arn (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore lambda_interceptor_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" )
Attributes
MCPGatewayConfigurationProperty
- class CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(*, instructions=None, search_type=None, session_configuration=None, streaming_configuration=None, supported_versions=None)
Bases:
objectThe gateway configuration for MCP.
- Parameters:
instructions (
Optional[str])search_type (
Optional[str]) – The MCP gateway configuration search type.session_configuration (
Union[IResolvable,SessionConfigurationProperty,Dict[str,Any],None])streaming_configuration (
Union[IResolvable,StreamingConfigurationProperty,Dict[str,Any],None])supported_versions (
Optional[Sequence[str]]) – The supported versions for the MCP configuration for the gateway target.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore m_cp_gateway_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", session_configuration=bedrockagentcore.CfnGatewayPropsMixin.SessionConfigurationProperty( session_timeout_in_seconds=123 ), streaming_configuration=bedrockagentcore.CfnGatewayPropsMixin.StreamingConfigurationProperty( enable_response_streaming=False ), supported_versions=["supportedVersions"] )
Attributes
- instructions
-
- Type:
see
- search_type
The MCP gateway configuration search type.
- session_configuration
-
- Type:
see
- streaming_configuration
-
- Type:
see
- supported_versions
The supported versions for the MCP configuration for the gateway target.
ManagedVpcResourceProperty
- class CfnGatewayPropsMixin.ManagedVpcResourceProperty(*, endpoint_ip_address_type=None, routing_domain=None, security_group_ids=None, subnet_ids=None, vpc_identifier=None)
Bases:
object- Parameters:
endpoint_ip_address_type (
Optional[str])routing_domain (
Optional[str])security_group_ids (
Optional[Sequence[str]])subnet_ids (
Optional[Sequence[str]])vpc_identifier (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore managed_vpc_resource_property = bedrockagentcore.CfnGatewayPropsMixin.ManagedVpcResourceProperty( endpoint_ip_address_type="endpointIpAddressType", routing_domain="routingDomain", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], vpc_identifier="vpcIdentifier" )
Attributes
- endpoint_ip_address_type
-
- Type:
see
- routing_domain
-
- Type:
see
- security_group_ids
-
- Type:
see
- subnet_ids
-
- Type:
see
PrivateEndpointProperty
- class CfnGatewayPropsMixin.PrivateEndpointProperty(*, managed_vpc_resource=None, self_managed_lattice_resource=None)
Bases:
object- Parameters:
managed_vpc_resource (
Union[IResolvable,ManagedVpcResourceProperty,Dict[str,Any],None])self_managed_lattice_resource (
Union[IResolvable,SelfManagedLatticeResourceProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore private_endpoint_property = bedrockagentcore.CfnGatewayPropsMixin.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnGatewayPropsMixin.ManagedVpcResourceProperty( endpoint_ip_address_type="endpointIpAddressType", routing_domain="routingDomain", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], vpc_identifier="vpcIdentifier" ), self_managed_lattice_resource=bedrockagentcore.CfnGatewayPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) )
Attributes
- managed_vpc_resource
-
- Type:
see
SelfManagedLatticeResourceProperty
- class CfnGatewayPropsMixin.SelfManagedLatticeResourceProperty(*, resource_configuration_identifier=None)
Bases:
object- Parameters:
resource_configuration_identifier (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore self_managed_lattice_resource_property = bedrockagentcore.CfnGatewayPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" )
Attributes
SessionConfigurationProperty
- class CfnGatewayPropsMixin.SessionConfigurationProperty(*, session_timeout_in_seconds=None)
Bases:
object- Parameters:
session_timeout_in_seconds (
Union[int,float,None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore session_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.SessionConfigurationProperty( session_timeout_in_seconds=123 )
Attributes
StreamingConfigurationProperty
- class CfnGatewayPropsMixin.StreamingConfigurationProperty(*, enable_response_streaming=None)
Bases:
object- Parameters:
enable_response_streaming (
Union[bool,IResolvable,None])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore streaming_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.StreamingConfigurationProperty( enable_response_streaming=False )
Attributes
WafConfigurationProperty
- class CfnGatewayPropsMixin.WafConfigurationProperty(*, failure_mode=None)
Bases:
object- Parameters:
failure_mode (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore waf_configuration_property = bedrockagentcore.CfnGatewayPropsMixin.WafConfigurationProperty( failure_mode="failureMode" )
Attributes
WorkloadIdentityDetailsProperty
- class CfnGatewayPropsMixin.WorkloadIdentityDetailsProperty(*, workload_identity_arn=None)
Bases:
objectThe workload identity details for the gateway.
- Parameters:
workload_identity_arn (
Optional[str])- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore workload_identity_details_property = bedrockagentcore.CfnGatewayPropsMixin.WorkloadIdentityDetailsProperty( workload_identity_arn="workloadIdentityArn" )
Attributes