CfnGatewayTargetPropsMixin
- class aws_cdk.cfn_property_mixins.aws_bedrockagentcore.CfnGatewayTargetPropsMixin(props, *, strategy=None)
Bases:
MixinAfter creating a gateway, you can add targets, which define the tools that your gateway will host.
For more information about adding gateway targets, see Add targets to an existing gateway .
See the Properties section below for descriptions of both the required and optional properties.
- See:
- CloudformationResource:
AWS::BedrockAgentCore::GatewayTarget
- 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 # parameter_values: Any # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty cfn_gateway_target_props_mixin = bedrockagentcore.CfnGatewayTargetPropsMixin(bedrockagentcore.CfnGatewayTargetMixinProps( credential_provider_configurations=[bedrockagentcore.CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty( credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.CredentialProviderProperty( api_key_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty( credential_location="credentialLocation", credential_parameter_name="credentialParameterName", credential_prefix="credentialPrefix", provider_arn="providerArn" ), iam_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.IamCredentialProviderProperty( region="region", service="service" ), oauth_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty( custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType", provider_arn="providerArn", scopes=["scopes"] ) ), credential_provider_type="credentialProviderType" )], description="description", gateway_identifier="gatewayIdentifier", metadata_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.MetadataConfigurationProperty( allowed_query_parameters=["allowedQueryParameters"], allowed_request_headers=["allowedRequestHeaders"], allowed_response_headers=["allowedResponseHeaders"] ), name="name", private_endpoint=bedrockagentcore.CfnGatewayTargetPropsMixin.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnGatewayTargetPropsMixin.ManagedVpcResourceProperty( endpoint_ip_address_type="endpointIpAddressType", routing_domain="routingDomain", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], vpc_identifier="vpcIdentifier" ), self_managed_lattice_resource=bedrockagentcore.CfnGatewayTargetPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) ), target_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.TargetConfigurationProperty( http=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpTargetConfigurationProperty( agentcore_runtime=bedrockagentcore.CfnGatewayTargetPropsMixin.RuntimeTargetConfigurationProperty( arn="arn", qualifier="qualifier", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) ), passthrough=bedrockagentcore.CfnGatewayTargetPropsMixin.PassthroughTargetConfigurationProperty( endpoint="endpoint", protocol_type="protocolType", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), stickiness_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.StickinessConfigurationProperty( identifier="identifier", timeout=123 ) ) ), mcp=bedrockagentcore.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty( api_gateway=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty( api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty( tool_filters=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )], tool_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )] ), rest_api_id="restApiId", stage="stage" ), connector=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorTargetConfigurationProperty( configurations=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty( description="description", name="name", parameter_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )], parameter_values=parameter_values )], enabled=["enabled"], source=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorSourceProperty( connector_id="connectorId" ) ), lambda_=bedrockagentcore.CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty( lambda_arn="lambdaArn", tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ToolSchemaProperty( inline_payload=[bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )], s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), mcp_server=bedrockagentcore.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty( endpoint="endpoint", listing_mode="listingMode", mcp_tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), resource_priority=123 ), open_api_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), smithy_model=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) ) ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::BedrockAgentCore::GatewayTarget.- Parameters:
props (
Union[CfnGatewayTargetMixinProps,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 = ['credentialProviderConfigurations', 'description', 'gatewayIdentifier', 'metadataConfiguration', 'name', 'privateEndpoint', 'targetConfiguration']
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.
ApiGatewayTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty(*, api_gateway_tool_configuration=None, rest_api_id=None, stage=None)
Bases:
object- Parameters:
api_gateway_tool_configuration (
Union[IResolvable,ApiGatewayToolConfigurationProperty,Dict[str,Any],None])rest_api_id (
Optional[str])stage (
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 api_gateway_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty( api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty( tool_filters=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )], tool_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )] ), rest_api_id="restApiId", stage="stage" )
Attributes
- api_gateway_tool_configuration
-
- Type:
see
- rest_api_id
-
- Type:
see
ApiGatewayToolConfigurationProperty
- class CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty(*, tool_filters=None, tool_overrides=None)
Bases:
object- Parameters:
tool_filters (
Union[IResolvable,Sequence[Union[IResolvable,ApiGatewayToolFilterProperty,Dict[str,Any]]],None])tool_overrides (
Union[IResolvable,Sequence[Union[IResolvable,ApiGatewayToolOverrideProperty,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 api_gateway_tool_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty( tool_filters=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )], tool_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )] )
Attributes
- tool_filters
-
- Type:
see
ApiGatewayToolFilterProperty
- class CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty(*, filter_path=None, methods=None)
Bases:
object- Parameters:
filter_path (
Optional[str])methods (
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 api_gateway_tool_filter_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )
Attributes
- filter_path
-
- Type:
see
ApiGatewayToolOverrideProperty
- class CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty(*, description=None, method=None, name=None, path=None)
Bases:
object- Parameters:
description (
Optional[str])method (
Optional[str])name (
Optional[str])path (
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 api_gateway_tool_override_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )
Attributes
- description
-
- Type:
see
- method
-
- Type:
see
- name
-
- Type:
see
ApiKeyCredentialProviderProperty
- class CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty(*, credential_location=None, credential_parameter_name=None, credential_prefix=None, provider_arn=None)
Bases:
objectThe API key credential provider for the gateway target.
- Parameters:
credential_location (
Optional[str]) – The credential location for the gateway target.credential_parameter_name (
Optional[str]) – The credential parameter name for the provider for the gateway target.credential_prefix (
Optional[str]) – The API key credential provider for the gateway target.provider_arn (
Optional[str]) – The provider ARN 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 api_key_credential_provider_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty( credential_location="credentialLocation", credential_parameter_name="credentialParameterName", credential_prefix="credentialPrefix", provider_arn="providerArn" )
Attributes
- credential_location
The credential location for the gateway target.
- credential_parameter_name
The credential parameter name for the provider for the gateway target.
- credential_prefix
The API key credential provider for the gateway target.
- provider_arn
The provider ARN for the gateway target.
ApiSchemaConfigurationProperty
- class CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty(*, inline_payload=None, s3=None)
Bases:
objectThe API schema configuration for the gateway target.
- Parameters:
inline_payload (
Optional[str]) – The inline payload for the gateway.s3 (
Union[IResolvable,S3ConfigurationProperty,Dict[str,Any],None]) – The API schema configuration.
- 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 api_schema_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) )
Attributes
- inline_payload
The inline payload for the gateway.
ConnectorConfigurationProperty
- class CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty(*, description=None, name=None, parameter_overrides=None, parameter_values=None)
Bases:
object- Parameters:
description (
Optional[str])name (
Optional[str])parameter_overrides (
Union[IResolvable,Sequence[Union[IResolvable,ConnectorParameterOverrideProperty,Dict[str,Any]]],None])parameter_values (
Any)
- 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 # parameter_values: Any connector_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty( description="description", name="name", parameter_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )], parameter_values=parameter_values )
Attributes
- description
-
- Type:
see
- name
-
- Type:
see
- parameter_overrides
-
- Type:
see
ConnectorParameterOverrideProperty
- class CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty(*, description=None, path=None, visible=None)
Bases:
object- Parameters:
description (
Optional[str])path (
Optional[str])visible (
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 connector_parameter_override_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )
Attributes
- description
-
- Type:
see
- path
-
- Type:
see
ConnectorSourceProperty
- class CfnGatewayTargetPropsMixin.ConnectorSourceProperty(*, connector_id=None)
Bases:
object- Parameters:
connector_id (
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 connector_source_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorSourceProperty( connector_id="connectorId" )
Attributes
ConnectorTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.ConnectorTargetConfigurationProperty(*, configurations=None, enabled=None, source=None)
Bases:
object- Parameters:
configurations (
Union[IResolvable,Sequence[Union[IResolvable,ConnectorConfigurationProperty,Dict[str,Any]]],None])enabled (
Optional[Sequence[str]])source (
Union[IResolvable,ConnectorSourceProperty,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 # parameter_values: Any connector_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorTargetConfigurationProperty( configurations=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty( description="description", name="name", parameter_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )], parameter_values=parameter_values )], enabled=["enabled"], source=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorSourceProperty( connector_id="connectorId" ) )
Attributes
- configurations
-
- Type:
see
- enabled
-
- Type:
see
CredentialProviderConfigurationProperty
- class CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty(*, credential_provider=None, credential_provider_type=None)
Bases:
objectThe credential provider configuration for the gateway target.
- Parameters:
credential_provider (
Union[IResolvable,CredentialProviderProperty,Dict[str,Any],None]) – The credential provider for the gateway target.credential_provider_type (
Optional[str]) – The credential provider type 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 credential_provider_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty( credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.CredentialProviderProperty( api_key_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty( credential_location="credentialLocation", credential_parameter_name="credentialParameterName", credential_prefix="credentialPrefix", provider_arn="providerArn" ), iam_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.IamCredentialProviderProperty( region="region", service="service" ), oauth_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty( custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType", provider_arn="providerArn", scopes=["scopes"] ) ), credential_provider_type="credentialProviderType" )
Attributes
- credential_provider
The credential provider for the gateway target.
- credential_provider_type
The credential provider type for the gateway target.
CredentialProviderProperty
- class CfnGatewayTargetPropsMixin.CredentialProviderProperty(*, api_key_credential_provider=None, iam_credential_provider=None, oauth_credential_provider=None)
Bases:
object- Parameters:
api_key_credential_provider (
Union[IResolvable,ApiKeyCredentialProviderProperty,Dict[str,Any],None]) – The API key credential provider.iam_credential_provider (
Union[IResolvable,IamCredentialProviderProperty,Dict[str,Any],None])oauth_credential_provider (
Union[IResolvable,OAuthCredentialProviderProperty,Dict[str,Any],None]) – The OAuth credential provider 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 credential_provider_property = bedrockagentcore.CfnGatewayTargetPropsMixin.CredentialProviderProperty( api_key_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty( credential_location="credentialLocation", credential_parameter_name="credentialParameterName", credential_prefix="credentialPrefix", provider_arn="providerArn" ), iam_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.IamCredentialProviderProperty( region="region", service="service" ), oauth_credential_provider=bedrockagentcore.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty( custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType", provider_arn="providerArn", scopes=["scopes"] ) )
Attributes
- api_key_credential_provider
The API key credential provider.
- iam_credential_provider
-
- Type:
see
- oauth_credential_provider
The OAuth credential provider for the gateway target.
HttpApiSchemaConfigurationProperty
- class CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty(*, source=None)
Bases:
object- Parameters:
source (
Union[IResolvable,ApiSchemaConfigurationProperty,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 http_api_schema_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) )
Attributes
HttpTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.HttpTargetConfigurationProperty(*, agentcore_runtime=None, passthrough=None)
Bases:
object- Parameters:
agentcore_runtime (
Union[IResolvable,RuntimeTargetConfigurationProperty,Dict[str,Any],None])passthrough (
Union[IResolvable,PassthroughTargetConfigurationProperty,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 http_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.HttpTargetConfigurationProperty( agentcore_runtime=bedrockagentcore.CfnGatewayTargetPropsMixin.RuntimeTargetConfigurationProperty( arn="arn", qualifier="qualifier", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) ), passthrough=bedrockagentcore.CfnGatewayTargetPropsMixin.PassthroughTargetConfigurationProperty( endpoint="endpoint", protocol_type="protocolType", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), stickiness_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.StickinessConfigurationProperty( identifier="identifier", timeout=123 ) ) )
Attributes
- agentcore_runtime
-
- Type:
see
IamCredentialProviderProperty
- class CfnGatewayTargetPropsMixin.IamCredentialProviderProperty(*, region=None, service=None)
Bases:
object- Parameters:
region (
Optional[str])service (
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 iam_credential_provider_property = bedrockagentcore.CfnGatewayTargetPropsMixin.IamCredentialProviderProperty( region="region", service="service" )
Attributes
- region
-
- Type:
see
ManagedResourceDetailsProperty
- class CfnGatewayTargetPropsMixin.ManagedResourceDetailsProperty(*, domain=None, resource_association_arn=None, resource_gateway_arn=None)
Bases:
object- Parameters:
domain (
Optional[str])resource_association_arn (
Optional[str])resource_gateway_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 managed_resource_details_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ManagedResourceDetailsProperty( domain="domain", resource_association_arn="resourceAssociationArn", resource_gateway_arn="resourceGatewayArn" )
Attributes
- domain
-
- Type:
see
- resource_association_arn
-
- Type:
see
ManagedVpcResourceProperty
- class CfnGatewayTargetPropsMixin.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.CfnGatewayTargetPropsMixin.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
McpLambdaTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty(*, lambda_arn=None, tool_schema=None)
Bases:
objectThe Lambda target configuration.
- Parameters:
lambda_arn (
Optional[str]) – The ARN of the Lambda target configuration.tool_schema (
Union[IResolvable,ToolSchemaProperty,Dict[str,Any],None]) – The tool schema configuration for the gateway target MCP configuration for 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 # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty mcp_lambda_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty( lambda_arn="lambdaArn", tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ToolSchemaProperty( inline_payload=[bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )], s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) )
Attributes
- lambda_arn
The ARN of the Lambda target configuration.
- tool_schema
The tool schema configuration for the gateway target MCP configuration for Lambda.
McpServerTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty(*, endpoint=None, listing_mode=None, mcp_tool_schema=None, resource_priority=None)
Bases:
object- Parameters:
endpoint (
Optional[str])listing_mode (
Optional[str])mcp_tool_schema (
Union[IResolvable,McpToolSchemaConfigurationProperty,Dict[str,Any],None])resource_priority (
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 mcp_server_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty( endpoint="endpoint", listing_mode="listingMode", mcp_tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), resource_priority=123 )
Attributes
- endpoint
-
- Type:
see
- listing_mode
-
- Type:
see
- mcp_tool_schema
-
- Type:
see
McpTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty(*, api_gateway=None, connector=None, lambda_=None, mcp_server=None, open_api_schema=None, smithy_model=None)
Bases:
objectThe MCP target configuration for the gateway target.
- Parameters:
api_gateway (
Union[IResolvable,ApiGatewayTargetConfigurationProperty,Dict[str,Any],None])connector (
Union[IResolvable,ConnectorTargetConfigurationProperty,Dict[str,Any],None])lambda – The Lambda MCP configuration for the gateway target.
mcp_server (
Union[IResolvable,McpServerTargetConfigurationProperty,Dict[str,Any],None])open_api_schema (
Union[IResolvable,ApiSchemaConfigurationProperty,Dict[str,Any],None]) – The OpenApi schema for the gateway target MCP configuration.smithy_model (
Union[IResolvable,ApiSchemaConfigurationProperty,Dict[str,Any],None]) – The target configuration for the Smithy model 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 # parameter_values: Any # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty mcp_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty( api_gateway=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty( api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty( tool_filters=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )], tool_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )] ), rest_api_id="restApiId", stage="stage" ), connector=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorTargetConfigurationProperty( configurations=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty( description="description", name="name", parameter_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )], parameter_values=parameter_values )], enabled=["enabled"], source=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorSourceProperty( connector_id="connectorId" ) ), lambda_=bedrockagentcore.CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty( lambda_arn="lambdaArn", tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ToolSchemaProperty( inline_payload=[bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )], s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), mcp_server=bedrockagentcore.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty( endpoint="endpoint", listing_mode="listingMode", mcp_tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), resource_priority=123 ), open_api_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), smithy_model=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) )
Attributes
- api_gateway
-
- Type:
see
- connector
-
- Type:
see
- lambda_
The Lambda MCP configuration for the gateway target.
- mcp_server
-
- Type:
see
- open_api_schema
The OpenApi schema for the gateway target MCP configuration.
- smithy_model
The target configuration for the Smithy model target.
McpToolSchemaConfigurationProperty
- class CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty(*, inline_payload=None, s3=None)
Bases:
object- Parameters:
inline_payload (
Optional[str])s3 (
Union[IResolvable,S3ConfigurationProperty,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 mcp_tool_schema_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) )
Attributes
- inline_payload
-
- Type:
see
MetadataConfigurationProperty
- class CfnGatewayTargetPropsMixin.MetadataConfigurationProperty(*, allowed_query_parameters=None, allowed_request_headers=None, allowed_response_headers=None)
Bases:
object- Parameters:
allowed_query_parameters (
Optional[Sequence[str]])allowed_request_headers (
Optional[Sequence[str]])allowed_response_headers (
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 metadata_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.MetadataConfigurationProperty( allowed_query_parameters=["allowedQueryParameters"], allowed_request_headers=["allowedRequestHeaders"], allowed_response_headers=["allowedResponseHeaders"] )
Attributes
- allowed_query_parameters
-
- Type:
see
- allowed_request_headers
-
- Type:
see
OAuthCredentialProviderProperty
- class CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty(*, custom_parameters=None, default_return_url=None, grant_type=None, provider_arn=None, scopes=None)
Bases:
objectThe OAuth credential provider for the gateway target.
- Parameters:
custom_parameters (
Union[IResolvable,Mapping[str,str],None]) – The OAuth credential provider.default_return_url (
Optional[str]) – Return URL for OAuth callback.grant_type (
Optional[str])provider_arn (
Optional[str]) – The provider ARN for the gateway target.scopes (
Optional[Sequence[str]]) – The OAuth credential provider scopes.
- 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 o_auth_credential_provider_property = bedrockagentcore.CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty( custom_parameters={ "custom_parameters_key": "customParameters" }, default_return_url="defaultReturnUrl", grant_type="grantType", provider_arn="providerArn", scopes=["scopes"] )
Attributes
- custom_parameters
The OAuth credential provider.
- default_return_url
Return URL for OAuth callback.
- grant_type
-
- Type:
see
- provider_arn
The provider ARN for the gateway target.
PassthroughTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.PassthroughTargetConfigurationProperty(*, endpoint=None, protocol_type=None, schema=None, stickiness_configuration=None)
Bases:
object- Parameters:
endpoint (
Optional[str])protocol_type (
Optional[str])schema (
Union[IResolvable,HttpApiSchemaConfigurationProperty,Dict[str,Any],None])stickiness_configuration (
Union[IResolvable,StickinessConfigurationProperty,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 passthrough_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.PassthroughTargetConfigurationProperty( endpoint="endpoint", protocol_type="protocolType", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), stickiness_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.StickinessConfigurationProperty( identifier="identifier", timeout=123 ) )
Attributes
- endpoint
-
- Type:
see
- protocol_type
-
- Type:
see
- schema
-
- Type:
see
PrivateEndpointProperty
- class CfnGatewayTargetPropsMixin.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.CfnGatewayTargetPropsMixin.PrivateEndpointProperty( managed_vpc_resource=bedrockagentcore.CfnGatewayTargetPropsMixin.ManagedVpcResourceProperty( endpoint_ip_address_type="endpointIpAddressType", routing_domain="routingDomain", security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"], vpc_identifier="vpcIdentifier" ), self_managed_lattice_resource=bedrockagentcore.CfnGatewayTargetPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" ) )
Attributes
- managed_vpc_resource
-
- Type:
see
RuntimeTargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.RuntimeTargetConfigurationProperty(*, arn=None, qualifier=None, schema=None)
Bases:
object- Parameters:
arn (
Optional[str])qualifier (
Optional[str])schema (
Union[IResolvable,HttpApiSchemaConfigurationProperty,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 runtime_target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.RuntimeTargetConfigurationProperty( arn="arn", qualifier="qualifier", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) )
Attributes
- arn
-
- Type:
see
- qualifier
-
- Type:
see
S3ConfigurationProperty
- class CfnGatewayTargetPropsMixin.S3ConfigurationProperty(*, bucket_owner_account_id=None, uri=None)
Bases:
objectThe S3 configuration for the gateway target.
- Parameters:
bucket_owner_account_id (
Optional[str]) – The S3 configuration bucket owner account ID for the gateway target.uri (
Optional[str]) – The configuration URI 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 s3_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" )
Attributes
- bucket_owner_account_id
The S3 configuration bucket owner account ID for the gateway target.
- uri
The configuration URI for the gateway target.
SchemaDefinitionProperty
- class CfnGatewayTargetPropsMixin.SchemaDefinitionProperty(*, description=None, items=None, properties=None, required=None, type=None)
Bases:
objectThe schema definition for the gateway target.
- Parameters:
description (
Optional[str]) – The workload identity details for the gateway.items (
Union[IResolvable,SchemaDefinitionProperty,Dict[str,Any],None])properties (
Union[IResolvable,Mapping[str,Union[IResolvable,SchemaDefinitionProperty,Dict[str,Any]]],None]) – The schema definition properties for the gateway target.required (
Optional[Sequence[str]]) – The schema definition.type (
Optional[str]) – The scheme definition type 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 # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty schema_definition_property = bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" )
Attributes
- description
The workload identity details for the gateway.
- items
-
- Type:
see
- properties
The schema definition properties for the gateway target.
- required
The schema definition.
- type
The scheme definition type for the gateway target.
SelfManagedLatticeResourceProperty
- class CfnGatewayTargetPropsMixin.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.CfnGatewayTargetPropsMixin.SelfManagedLatticeResourceProperty( resource_configuration_identifier="resourceConfigurationIdentifier" )
Attributes
StickinessConfigurationProperty
- class CfnGatewayTargetPropsMixin.StickinessConfigurationProperty(*, identifier=None, timeout=None)
Bases:
object- Parameters:
identifier (
Optional[str])timeout (
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 stickiness_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.StickinessConfigurationProperty( identifier="identifier", timeout=123 )
Attributes
- identifier
-
- Type:
see
TargetConfigurationProperty
- class CfnGatewayTargetPropsMixin.TargetConfigurationProperty(*, http=None, mcp=None)
Bases:
objectThe target configuration.
- Parameters:
http (
Union[IResolvable,HttpTargetConfigurationProperty,Dict[str,Any],None])mcp (
Union[IResolvable,McpTargetConfigurationProperty,Dict[str,Any],None]) – The target configuration definition 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 # parameter_values: Any # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty target_configuration_property = bedrockagentcore.CfnGatewayTargetPropsMixin.TargetConfigurationProperty( http=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpTargetConfigurationProperty( agentcore_runtime=bedrockagentcore.CfnGatewayTargetPropsMixin.RuntimeTargetConfigurationProperty( arn="arn", qualifier="qualifier", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) ), passthrough=bedrockagentcore.CfnGatewayTargetPropsMixin.PassthroughTargetConfigurationProperty( endpoint="endpoint", protocol_type="protocolType", schema=bedrockagentcore.CfnGatewayTargetPropsMixin.HttpApiSchemaConfigurationProperty( source=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), stickiness_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.StickinessConfigurationProperty( identifier="identifier", timeout=123 ) ) ), mcp=bedrockagentcore.CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty( api_gateway=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty( api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty( tool_filters=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty( filter_path="filterPath", methods=["methods"] )], tool_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty( description="description", method="method", name="name", path="path" )] ), rest_api_id="restApiId", stage="stage" ), connector=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorTargetConfigurationProperty( configurations=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorConfigurationProperty( description="description", name="name", parameter_overrides=[bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorParameterOverrideProperty( description="description", path="path", visible=False )], parameter_values=parameter_values )], enabled=["enabled"], source=bedrockagentcore.CfnGatewayTargetPropsMixin.ConnectorSourceProperty( connector_id="connectorId" ) ), lambda_=bedrockagentcore.CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty( lambda_arn="lambdaArn", tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ToolSchemaProperty( inline_payload=[bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )], s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ), mcp_server=bedrockagentcore.CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty( endpoint="endpoint", listing_mode="listingMode", mcp_tool_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.McpToolSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), resource_priority=123 ), open_api_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ), smithy_model=bedrockagentcore.CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty( inline_payload="inlinePayload", s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) ) ) )
Attributes
- http
-
- Type:
see
- mcp
The target configuration definition for MCP.
ToolDefinitionProperty
- class CfnGatewayTargetPropsMixin.ToolDefinitionProperty(*, description=None, input_schema=None, name=None, output_schema=None)
Bases:
objectThe tool definition for the gateway.
- Parameters:
description (
Optional[str])input_schema (
Union[IResolvable,SchemaDefinitionProperty,Dict[str,Any],None]) – The input schema for the gateway target.name (
Optional[str]) – The tool name.output_schema (
Union[IResolvable,SchemaDefinitionProperty,Dict[str,Any],None]) – The tool definition output schema 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 # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty tool_definition_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )
Attributes
- description
-
- Type:
see
- input_schema
The input schema for the gateway target.
- name
The tool name.
- output_schema
The tool definition output schema for the gateway target.
ToolSchemaProperty
- class CfnGatewayTargetPropsMixin.ToolSchemaProperty(*, inline_payload=None, s3=None)
Bases:
objectThe tool schema for the gateway target.
- Parameters:
inline_payload (
Union[IResolvable,Sequence[Union[IResolvable,ToolDefinitionProperty,Dict[str,Any]]],None]) – The inline payload for the gateway target.s3 (
Union[IResolvable,S3ConfigurationProperty,Dict[str,Any],None]) – The S3 tool schema 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 # schema_definition_property_: bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty tool_schema_property = bedrockagentcore.CfnGatewayTargetPropsMixin.ToolSchemaProperty( inline_payload=[bedrockagentcore.CfnGatewayTargetPropsMixin.ToolDefinitionProperty( description="description", input_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ), name="name", output_schema=bedrockagentcore.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty( description="description", items=schema_definition_property_, properties={ "properties_key": schema_definition_property_ }, required=["required"], type="type" ) )], s3=bedrockagentcore.CfnGatewayTargetPropsMixin.S3ConfigurationProperty( bucket_owner_account_id="bucketOwnerAccountId", uri="uri" ) )
Attributes
- inline_payload
The inline payload for the gateway target.
- s3
The S3 tool schema for the gateway target.