CfnGatewayPropsMixin
- class aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins cfn_gateway_props_mixin = bedrockagentcore_mixins.CfnGatewayPropsMixin(bedrockagentcore_mixins.CfnGatewayMixinProps( authorizer_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.AuthorizerConfigurationProperty( custom_jwt_authorizer=bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty( allowed_audience=["allowedAudience"], allowed_clients=["allowedClients"], allowed_scopes=["allowedScopes"], custom_claims=[bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore_mixins.CfnGatewayPropsMixin.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore_mixins.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" ) ), authorizer_type="authorizerType", description="description", exception_level="exceptionLevel", interceptor_configurations=[bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayInterceptorConfigurationProperty( input_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False ), interception_points=["interceptionPoints"], interceptor=bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore_mixins.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) ) )], kms_key_arn="kmsKeyArn", name="name", protocol_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty( mcp=bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", supported_versions=["supportedVersions"] ) ), protocol_type="protocolType", role_arn="roleArn", tags={ "tags_key": "tags" } ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::BedrockAgentCore::Gateway.- Parameters:
props (
Union[CfnGatewayMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- 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', 'protocolConfiguration', 'protocolType', 'roleArn', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) 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.- Stability:
experimental
ClaimMatchValueTypeProperty
- class CfnGatewayPropsMixin.ClaimMatchValueTypeProperty(*, match_value_string=None, match_value_string_list=None)
Bases:
objectThe value or values in the custom claim to match for.
- Parameters:
match_value_string (
Optional[str]) – The string value to match for.match_value_string_list (
Optional[Sequence[str]]) – The list of strings to check for a match.
- 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins claim_match_value_type_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.ClaimMatchValueTypeProperty( match_value_string="matchValueString", match_value_string_list=["matchValueStringList"] )
Attributes
- match_value_string
The string value to match for.
- match_value_string_list
The list of strings to check for a match.
CustomClaimValidationTypeProperty
- class CfnGatewayPropsMixin.CustomClaimValidationTypeProperty(*, authorizing_claim_match_value=None, inbound_token_claim_name=None, inbound_token_claim_value_type=None)
Bases:
objectRequired custom claim.
- Parameters:
authorizing_claim_match_value (
Union[IResolvable,AuthorizingClaimMatchValueTypeProperty,Dict[str,Any],None]) – The value or values in the custom claim to match and relationship of match.inbound_token_claim_name (
Optional[str]) – The name of the custom claim to validate.inbound_token_claim_value_type (
Optional[str]) – Token claim data type.
- 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins custom_claim_validation_type_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomClaimValidationTypeProperty( authorizing_claim_match_value=bedrockagentcore_mixins.CfnGatewayPropsMixin.AuthorizingClaimMatchValueTypeProperty( claim_match_operator="claimMatchOperator", claim_match_value=bedrockagentcore_mixins.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
The value or values in the custom claim to match and relationship of match.
- inbound_token_claim_name
The name of the custom claim to validate.
- inbound_token_claim_value_type
Token claim data type.
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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins gateway_interceptor_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayInterceptorConfigurationProperty( input_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False ), interception_points=["interceptionPoints"], interceptor=bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore_mixins.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) ) )
Attributes
- input_configuration
-
- Type:
see
- interception_points
-
- 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins gateway_protocol_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty( mcp=bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", 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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins interceptor_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorConfigurationProperty( lambda_=bedrockagentcore_mixins.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" ) )
Attributes
InterceptorInputConfigurationProperty
- class CfnGatewayPropsMixin.InterceptorInputConfigurationProperty(*, pass_request_headers=None)
Bases:
object- Parameters:
pass_request_headers (
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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins interceptor_input_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.InterceptorInputConfigurationProperty( pass_request_headers=False )
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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins lambda_interceptor_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.LambdaInterceptorConfigurationProperty( arn="arn" )
Attributes
MCPGatewayConfigurationProperty
- class CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(*, instructions=None, search_type=None, supported_versions=None)
Bases:
objectThe gateway configuration for MCP.
- Parameters:
instructions (
Optional[str])search_type (
Optional[str]) – The MCP gateway configuration search type.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins m_cPGateway_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty( instructions="instructions", search_type="searchType", supported_versions=["supportedVersions"] )
Attributes
- instructions
-
- Type:
see
- search_type
The MCP gateway configuration search type.
- supported_versions
The supported versions for the MCP configuration for the gateway target.
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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins workload_identity_details_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.WorkloadIdentityDetailsProperty( workload_identity_arn="workloadIdentityArn" )
Attributes