CfnGatewayTarget

class aws_cdk.aws_bedrockagentcore.CfnGatewayTarget(scope, id, *, name, target_configuration, credential_provider_configurations=None, description=None, gateway_identifier=None, metadata_configuration=None, private_endpoint=None)

Bases: CfnResource

After 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html

CloudformationResource:

AWS::BedrockAgentCore::GatewayTarget

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

cfn_gateway_target = bedrockagentcore.CfnGatewayTarget(self, "MyCfnGatewayTarget",
    name="name",
    target_configuration=bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
        http=bedrockagentcore.CfnGatewayTarget.HttpTargetConfigurationProperty(
            agentcore_runtime=bedrockagentcore.CfnGatewayTarget.RuntimeTargetConfigurationProperty(
                arn="arn",

                # the properties below are optional
                qualifier="qualifier"
            )
        ),
        mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
            api_gateway=bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
                api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
                    tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
                        filter_path="filterPath",
                        methods=["methods"]
                    )],

                    # the properties below are optional
                    tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
                        method="method",
                        name="name",
                        path="path",

                        # the properties below are optional
                        description="description"
                    )]
                ),
                rest_api_id="restApiId",
                stage="stage"
            ),
            lambda_=bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
                lambda_arn="lambdaArn",
                tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
                    inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
                        description="description",
                        input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                            type="type",

                            # the properties below are optional
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"]
                        ),
                        name="name",

                        # the properties below are optional
                        output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                            type="type",

                            # the properties below are optional
                            description="description",
                            items=schema_definition_property_,
                            properties={
                                "properties_key": schema_definition_property_
                            },
                            required=["required"]
                        )
                    )],
                    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                        bucket_owner_account_id="bucketOwnerAccountId",
                        uri="uri"
                    )
                )
            ),
            mcp_server=bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
                endpoint="endpoint",

                # the properties below are optional
                listing_mode="listingMode",
                mcp_tool_schema=bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
                    inline_payload="inlinePayload",
                    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                        bucket_owner_account_id="bucketOwnerAccountId",
                        uri="uri"
                    )
                ),
                resource_priority=123
            ),
            open_api_schema=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            ),
            smithy_model=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            )
        )
    ),

    # the properties below are optional
    credential_provider_configurations=[bedrockagentcore.CfnGatewayTarget.CredentialProviderConfigurationProperty(
        credential_provider_type="credentialProviderType",

        # the properties below are optional
        credential_provider=bedrockagentcore.CfnGatewayTarget.CredentialProviderProperty(
            api_key_credential_provider=bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
                provider_arn="providerArn",

                # the properties below are optional
                credential_location="credentialLocation",
                credential_parameter_name="credentialParameterName",
                credential_prefix="credentialPrefix"
            ),
            iam_credential_provider=bedrockagentcore.CfnGatewayTarget.IamCredentialProviderProperty(
                service="service",

                # the properties below are optional
                region="region"
            ),
            oauth_credential_provider=bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
                provider_arn="providerArn",
                scopes=["scopes"],

                # the properties below are optional
                custom_parameters={
                    "custom_parameters_key": "customParameters"
                },
                default_return_url="defaultReturnUrl",
                grant_type="grantType"
            )
        )
    )],
    description="description",
    gateway_identifier="gatewayIdentifier",
    metadata_configuration=bedrockagentcore.CfnGatewayTarget.MetadataConfigurationProperty(
        allowed_query_parameters=["allowedQueryParameters"],
        allowed_request_headers=["allowedRequestHeaders"],
        allowed_response_headers=["allowedResponseHeaders"]
    ),
    private_endpoint=bedrockagentcore.CfnGatewayTarget.PrivateEndpointProperty(
        managed_vpc_resource=bedrockagentcore.CfnGatewayTarget.ManagedVpcResourceProperty(
            endpoint_ip_address_type="endpointIpAddressType",
            subnet_ids=["subnetIds"],
            vpc_identifier="vpcIdentifier",

            # the properties below are optional
            routing_domain="routingDomain",
            security_group_ids=["securityGroupIds"]
        ),
        self_managed_lattice_resource=bedrockagentcore.CfnGatewayTarget.SelfManagedLatticeResourceProperty(
            resource_configuration_identifier="resourceConfigurationIdentifier"
        )
    )
)

Create a new AWS::BedrockAgentCore::GatewayTarget.

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

• name (str) – The name for the gateway target.

• target_configuration (Union[IResolvable, TargetConfigurationProperty, Dict[str, Any]]) – The target configuration for the Smithy model target.

• credential_provider_configurations (Union[IResolvable, Sequence[Union[IResolvable, CredentialProviderConfigurationProperty, Dict[str, Any]]], None]) – The OAuth credential provider configuration.

• description (Optional[str]) – The description for the gateway target.

• gateway_identifier (Optional[str]) – The gateway ID for the gateway target.

• metadata_configuration (Union[IResolvable, MetadataConfigurationProperty, Dict[str, Any], None])

• private_endpoint (Union[IResolvable, PrivateEndpointProperty, Dict[str, Any], None])

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str)

• value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

• The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy])

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[CfnResource, Stack]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::BedrockAgentCore::GatewayTarget'

attr_authorization_data

AuthorizationData

Type:

cloudformationAttribute

attr_created_at

The date and time at which the gateway target was created.

CloudformationAttribute:

CreatedAt

attr_gateway_arn

GatewayArn

Type:

cloudformationAttribute

attr_last_synchronized_at

LastSynchronizedAt

Type:

cloudformationAttribute

attr_private_endpoint_managed_resources

PrivateEndpointManagedResources

Type:

cloudformationAttribute

attr_protocol_type

ProtocolType

Type:

cloudformationAttribute

attr_status

The status for the gateway target.

CloudformationAttribute:

Status

attr_status_reasons

The status reasons for the gateway target.

CloudformationAttribute:

StatusReasons

attr_target_id

The target ID for the gateway target.

CloudformationAttribute:

TargetId

attr_updated_at

The time at which the resource was updated.

CloudformationAttribute:

UpdatedAt

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

credential_provider_configurations

The OAuth credential provider configuration.

description

The description for the gateway target.

env

gateway_identifier

The gateway ID for the gateway target.

gateway_target_ref

A reference to a GatewayTarget resource.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

metadata_configuration

name

The name for the gateway target.

node

The tree node.

private_endpoint

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

target_configuration

The target configuration for the Smithy model target.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_gateway_target(x)

Checks whether the given object is a CfnGatewayTarget.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ApiGatewayTargetConfigurationProperty

class CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(*, api_gateway_tool_configuration, rest_api_id, stage)

Bases: object

Parameters:

• api_gateway_tool_configuration (Union[IResolvable, ApiGatewayToolConfigurationProperty, Dict[str, Any]])

• rest_api_id (str)

• stage (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

api_gateway_target_configuration_property = bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
    api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
        tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
            filter_path="filterPath",
            methods=["methods"]
        )],

        # the properties below are optional
        tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
            method="method",
            name="name",
            path="path",

            # the properties below are optional
            description="description"
        )]
    ),
    rest_api_id="restApiId",
    stage="stage"
)

Attributes

api_gateway_tool_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-apigatewaytoolconfiguration

Type:

see

rest_api_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-restapiid

Type:

see

stage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytargetconfiguration-stage

Type:

see

ApiGatewayToolConfigurationProperty

class CfnGatewayTarget.ApiGatewayToolConfigurationProperty(*, tool_filters, tool_overrides=None)

Bases: object

Parameters:

• tool_filters (Union[IResolvable, Sequence[Union[IResolvable, ApiGatewayToolFilterProperty, Dict[str, Any]]]])

• tool_overrides (Union[IResolvable, Sequence[Union[IResolvable, ApiGatewayToolOverrideProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

api_gateway_tool_configuration_property = bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
    tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
        filter_path="filterPath",
        methods=["methods"]
    )],

    # the properties below are optional
    tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
        method="method",
        name="name",
        path="path",

        # the properties below are optional
        description="description"
    )]
)

Attributes

tool_filters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-toolfilters

Type:

see

tool_overrides

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolconfiguration-tooloverrides

Type:

see

ApiGatewayToolFilterProperty

class CfnGatewayTarget.ApiGatewayToolFilterProperty(*, filter_path, methods)

Bases: object

Parameters:

• filter_path (str)

• methods (Sequence[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.html

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 import aws_bedrockagentcore as bedrockagentcore

api_gateway_tool_filter_property = bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
    filter_path="filterPath",
    methods=["methods"]
)

Attributes

filter_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-filterpath

Type:

see

methods

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytoolfilter.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytoolfilter-methods

Type:

see

ApiGatewayToolOverrideProperty

class CfnGatewayTarget.ApiGatewayToolOverrideProperty(*, method, name, path, description=None)

Bases: object

Parameters:

• method (str)

• name (str)

• path (str)

• description (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html

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 import aws_bedrockagentcore as bedrockagentcore

api_gateway_tool_override_property = bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
    method="method",
    name="name",
    path="path",

    # the properties below are optional
    description="description"
)

Attributes

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-description

Type:

see

method

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-method

Type:

see

name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-name

Type:

see

path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apigatewaytooloverride.html#cfn-bedrockagentcore-gatewaytarget-apigatewaytooloverride-path

Type:

see

ApiKeyCredentialProviderProperty

class CfnGatewayTarget.ApiKeyCredentialProviderProperty(*, provider_arn, credential_location=None, credential_parameter_name=None, credential_prefix=None)

Bases: object

The API key credential provider for the gateway target.

Parameters:

• provider_arn (str) – The provider ARN for the gateway target.

• 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html

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 import aws_bedrockagentcore as bedrockagentcore

api_key_credential_provider_property = bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
    provider_arn="providerArn",

    # the properties below are optional
    credential_location="credentialLocation",
    credential_parameter_name="credentialParameterName",
    credential_prefix="credentialPrefix"
)

Attributes

credential_location

The credential location for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentiallocation

credential_parameter_name

The credential parameter name for the provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialparametername

credential_prefix

The API key credential provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-credentialprefix

provider_arn

The provider ARN for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apikeycredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-apikeycredentialprovider-providerarn

ApiSchemaConfigurationProperty

class CfnGatewayTarget.ApiSchemaConfigurationProperty(*, inline_payload=None, s3=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

api_schema_configuration_property = bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
    inline_payload="inlinePayload",
    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
        bucket_owner_account_id="bucketOwnerAccountId",
        uri="uri"
    )
)

Attributes

inline_payload

The inline payload for the gateway.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-inlinepayload

s3

The API schema configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-apischemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-apischemaconfiguration-s3

AuthorizationDataProperty

class CfnGatewayTarget.AuthorizationDataProperty(*, oauth2)

Bases: object

Parameters:

oauth2 (Union[IResolvable, OAuth2AuthorizationDataProperty, Dict[str, Any]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-authorizationdata.html

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 import aws_bedrockagentcore as bedrockagentcore

authorization_data_property = bedrockagentcore.CfnGatewayTarget.AuthorizationDataProperty(
    oauth2=bedrockagentcore.CfnGatewayTarget.OAuth2AuthorizationDataProperty(
        authorization_url="authorizationUrl",

        # the properties below are optional
        user_id="userId"
    )
)

Attributes

oauth2

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-authorizationdata.html#cfn-bedrockagentcore-gatewaytarget-authorizationdata-oauth2

Type:

see

CredentialProviderConfigurationProperty

class CfnGatewayTarget.CredentialProviderConfigurationProperty(*, credential_provider_type, credential_provider=None)

Bases: object

The credential provider configuration for the gateway target.

Parameters:

• credential_provider_type (str) – The credential provider type for the gateway target.

• credential_provider (Union[IResolvable, CredentialProviderProperty, Dict[str, Any], None]) – The credential provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

credential_provider_configuration_property = bedrockagentcore.CfnGatewayTarget.CredentialProviderConfigurationProperty(
    credential_provider_type="credentialProviderType",

    # the properties below are optional
    credential_provider=bedrockagentcore.CfnGatewayTarget.CredentialProviderProperty(
        api_key_credential_provider=bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
            provider_arn="providerArn",

            # the properties below are optional
            credential_location="credentialLocation",
            credential_parameter_name="credentialParameterName",
            credential_prefix="credentialPrefix"
        ),
        iam_credential_provider=bedrockagentcore.CfnGatewayTarget.IamCredentialProviderProperty(
            service="service",

            # the properties below are optional
            region="region"
        ),
        oauth_credential_provider=bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
            provider_arn="providerArn",
            scopes=["scopes"],

            # the properties below are optional
            custom_parameters={
                "custom_parameters_key": "customParameters"
            },
            default_return_url="defaultReturnUrl",
            grant_type="grantType"
        )
    )
)

Attributes

credential_provider

The credential provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovider

credential_provider_type

The credential provider type for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialproviderconfiguration.html#cfn-bedrockagentcore-gatewaytarget-credentialproviderconfiguration-credentialprovidertype

CredentialProviderProperty

class CfnGatewayTarget.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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html

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 import aws_bedrockagentcore as bedrockagentcore

credential_provider_property = bedrockagentcore.CfnGatewayTarget.CredentialProviderProperty(
    api_key_credential_provider=bedrockagentcore.CfnGatewayTarget.ApiKeyCredentialProviderProperty(
        provider_arn="providerArn",

        # the properties below are optional
        credential_location="credentialLocation",
        credential_parameter_name="credentialParameterName",
        credential_prefix="credentialPrefix"
    ),
    iam_credential_provider=bedrockagentcore.CfnGatewayTarget.IamCredentialProviderProperty(
        service="service",

        # the properties below are optional
        region="region"
    ),
    oauth_credential_provider=bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
        provider_arn="providerArn",
        scopes=["scopes"],

        # the properties below are optional
        custom_parameters={
            "custom_parameters_key": "customParameters"
        },
        default_return_url="defaultReturnUrl",
        grant_type="grantType"
    )
)

Attributes

api_key_credential_provider

The API key credential provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-apikeycredentialprovider

iam_credential_provider

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-iamcredentialprovider

Type:

see

oauth_credential_provider

The OAuth credential provider for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-credentialprovider.html#cfn-bedrockagentcore-gatewaytarget-credentialprovider-oauthcredentialprovider

HttpTargetConfigurationProperty

class CfnGatewayTarget.HttpTargetConfigurationProperty(*, agentcore_runtime)

Bases: object

Parameters:

agentcore_runtime (Union[IResolvable, RuntimeTargetConfigurationProperty, Dict[str, Any]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-httptargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

http_target_configuration_property = bedrockagentcore.CfnGatewayTarget.HttpTargetConfigurationProperty(
    agentcore_runtime=bedrockagentcore.CfnGatewayTarget.RuntimeTargetConfigurationProperty(
        arn="arn",

        # the properties below are optional
        qualifier="qualifier"
    )
)

Attributes

agentcore_runtime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-httptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-httptargetconfiguration-agentcoreruntime

Type:

see

IamCredentialProviderProperty

class CfnGatewayTarget.IamCredentialProviderProperty(*, service, region=None)

Bases: object

Parameters:

• service (str)

• region (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.html

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 import aws_bedrockagentcore as bedrockagentcore

iam_credential_provider_property = bedrockagentcore.CfnGatewayTarget.IamCredentialProviderProperty(
    service="service",

    # the properties below are optional
    region="region"
)

Attributes

region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-region

Type:

see

service

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-iamcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-iamcredentialprovider-service

Type:

see

ManagedResourceDetailsProperty

class CfnGatewayTarget.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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedresourcedetails.html

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 import aws_bedrockagentcore as bedrockagentcore

managed_resource_details_property = bedrockagentcore.CfnGatewayTarget.ManagedResourceDetailsProperty(
    domain="domain",
    resource_association_arn="resourceAssociationArn",
    resource_gateway_arn="resourceGatewayArn"
)

Attributes

domain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedresourcedetails.html#cfn-bedrockagentcore-gatewaytarget-managedresourcedetails-domain

Type:

see

resource_association_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedresourcedetails.html#cfn-bedrockagentcore-gatewaytarget-managedresourcedetails-resourceassociationarn

Type:

see

resource_gateway_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedresourcedetails.html#cfn-bedrockagentcore-gatewaytarget-managedresourcedetails-resourcegatewayarn

Type:

see

ManagedVpcResourceProperty

class CfnGatewayTarget.ManagedVpcResourceProperty(*, endpoint_ip_address_type, subnet_ids, vpc_identifier, routing_domain=None, security_group_ids=None)

Bases: object

Parameters:

• endpoint_ip_address_type (str)

• subnet_ids (Sequence[str])

• vpc_identifier (str)

• routing_domain (Optional[str])

• security_group_ids (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html

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 import aws_bedrockagentcore as bedrockagentcore

managed_vpc_resource_property = bedrockagentcore.CfnGatewayTarget.ManagedVpcResourceProperty(
    endpoint_ip_address_type="endpointIpAddressType",
    subnet_ids=["subnetIds"],
    vpc_identifier="vpcIdentifier",

    # the properties below are optional
    routing_domain="routingDomain",
    security_group_ids=["securityGroupIds"]
)

Attributes

endpoint_ip_address_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html#cfn-bedrockagentcore-gatewaytarget-managedvpcresource-endpointipaddresstype

Type:

see

routing_domain

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html#cfn-bedrockagentcore-gatewaytarget-managedvpcresource-routingdomain

Type:

see

security_group_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html#cfn-bedrockagentcore-gatewaytarget-managedvpcresource-securitygroupids

Type:

see

subnet_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html#cfn-bedrockagentcore-gatewaytarget-managedvpcresource-subnetids

Type:

see

vpc_identifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-managedvpcresource.html#cfn-bedrockagentcore-gatewaytarget-managedvpcresource-vpcidentifier

Type:

see

McpLambdaTargetConfigurationProperty

class CfnGatewayTarget.McpLambdaTargetConfigurationProperty(*, lambda_arn, tool_schema)

Bases: object

The Lambda target configuration.

Parameters:

• lambda_arn (str) – The ARN of the Lambda target configuration.

• tool_schema (Union[IResolvable, ToolSchemaProperty, Dict[str, Any]]) – The tool schema configuration for the gateway target MCP configuration for Lambda.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

mcp_lambda_target_configuration_property = bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
    lambda_arn="lambdaArn",
    tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
        inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
            description="description",
            input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                type="type",

                # the properties below are optional
                description="description",
                items=schema_definition_property_,
                properties={
                    "properties_key": schema_definition_property_
                },
                required=["required"]
            ),
            name="name",

            # the properties below are optional
            output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                type="type",

                # the properties below are optional
                description="description",
                items=schema_definition_property_,
                properties={
                    "properties_key": schema_definition_property_
                },
                required=["required"]
            )
        )],
        s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
            bucket_owner_account_id="bucketOwnerAccountId",
            uri="uri"
        )
    )
)

Attributes

lambda_arn

The ARN of the Lambda target configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-lambdaarn

tool_schema

The tool schema configuration for the gateway target MCP configuration for Lambda.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcplambdatargetconfiguration-toolschema

McpServerTargetConfigurationProperty

class CfnGatewayTarget.McpServerTargetConfigurationProperty(*, endpoint, listing_mode=None, mcp_tool_schema=None, resource_priority=None)

Bases: object

Parameters:

• endpoint (str)

• listing_mode (Optional[str])

• mcp_tool_schema (Union[IResolvable, McpToolSchemaConfigurationProperty, Dict[str, Any], None])

• resource_priority (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

mcp_server_target_configuration_property = bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
    endpoint="endpoint",

    # the properties below are optional
    listing_mode="listingMode",
    mcp_tool_schema=bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
        inline_payload="inlinePayload",
        s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
            bucket_owner_account_id="bucketOwnerAccountId",
            uri="uri"
        )
    ),
    resource_priority=123
)

Attributes

endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-endpoint

Type:

see

listing_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-listingmode

Type:

see

mcp_tool_schema

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-mcptoolschema

Type:

see

resource_priority

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcpservertargetconfiguration-resourcepriority

Type:

see

McpTargetConfigurationProperty

class CfnGatewayTarget.McpTargetConfigurationProperty(*, api_gateway=None, lambda_=None, mcp_server=None, open_api_schema=None, smithy_model=None)

Bases: object

The MCP target configuration for the gateway target.

Parameters:

• api_gateway (Union[IResolvable, ApiGatewayTargetConfigurationProperty, 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

mcp_target_configuration_property = bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
    api_gateway=bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
        api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
            tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
                filter_path="filterPath",
                methods=["methods"]
            )],

            # the properties below are optional
            tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
                method="method",
                name="name",
                path="path",

                # the properties below are optional
                description="description"
            )]
        ),
        rest_api_id="restApiId",
        stage="stage"
    ),
    lambda_=bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
        lambda_arn="lambdaArn",
        tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
            inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
                description="description",
                input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                    type="type",

                    # the properties below are optional
                    description="description",
                    items=schema_definition_property_,
                    properties={
                        "properties_key": schema_definition_property_
                    },
                    required=["required"]
                ),
                name="name",

                # the properties below are optional
                output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                    type="type",

                    # the properties below are optional
                    description="description",
                    items=schema_definition_property_,
                    properties={
                        "properties_key": schema_definition_property_
                    },
                    required=["required"]
                )
            )],
            s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                bucket_owner_account_id="bucketOwnerAccountId",
                uri="uri"
            )
        )
    ),
    mcp_server=bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
        endpoint="endpoint",

        # the properties below are optional
        listing_mode="listingMode",
        mcp_tool_schema=bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
            inline_payload="inlinePayload",
            s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                bucket_owner_account_id="bucketOwnerAccountId",
                uri="uri"
            )
        ),
        resource_priority=123
    ),
    open_api_schema=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
        inline_payload="inlinePayload",
        s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
            bucket_owner_account_id="bucketOwnerAccountId",
            uri="uri"
        )
    ),
    smithy_model=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
        inline_payload="inlinePayload",
        s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
            bucket_owner_account_id="bucketOwnerAccountId",
            uri="uri"
        )
    )
)

Attributes

api_gateway

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-apigateway

Type:

see

lambda_

The Lambda MCP configuration for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-lambda

mcp_server

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-mcpserver

Type:

see

open_api_schema

The OpenApi schema for the gateway target MCP configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-openapischema

smithy_model

The target configuration for the Smithy model target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptargetconfiguration-smithymodel

McpToolSchemaConfigurationProperty

class CfnGatewayTarget.McpToolSchemaConfigurationProperty(*, inline_payload=None, s3=None)

Bases: object

Parameters:

• inline_payload (Optional[str])

• s3 (Union[IResolvable, S3ConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptoolschemaconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

mcp_tool_schema_configuration_property = bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
    inline_payload="inlinePayload",
    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
        bucket_owner_account_id="bucketOwnerAccountId",
        uri="uri"
    )
)

Attributes

inline_payload

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptoolschemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptoolschemaconfiguration-inlinepayload

Type:

see

s3

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-mcptoolschemaconfiguration.html#cfn-bedrockagentcore-gatewaytarget-mcptoolschemaconfiguration-s3

Type:

see

MetadataConfigurationProperty

class CfnGatewayTarget.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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

metadata_configuration_property = bedrockagentcore.CfnGatewayTarget.MetadataConfigurationProperty(
    allowed_query_parameters=["allowedQueryParameters"],
    allowed_request_headers=["allowedRequestHeaders"],
    allowed_response_headers=["allowedResponseHeaders"]
)

Attributes

allowed_query_parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedqueryparameters

Type:

see

allowed_request_headers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedrequestheaders

Type:

see

allowed_response_headers

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-metadataconfiguration.html#cfn-bedrockagentcore-gatewaytarget-metadataconfiguration-allowedresponseheaders

Type:

see

OAuth2AuthorizationDataProperty

class CfnGatewayTarget.OAuth2AuthorizationDataProperty(*, authorization_url, user_id=None)

Bases: object

Parameters:

• authorization_url (str)

• user_id (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauth2authorizationdata.html

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 import aws_bedrockagentcore as bedrockagentcore

o_auth2_authorization_data_property = bedrockagentcore.CfnGatewayTarget.OAuth2AuthorizationDataProperty(
    authorization_url="authorizationUrl",

    # the properties below are optional
    user_id="userId"
)

Attributes

authorization_url

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauth2authorizationdata.html#cfn-bedrockagentcore-gatewaytarget-oauth2authorizationdata-authorizationurl

Type:

see

user_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauth2authorizationdata.html#cfn-bedrockagentcore-gatewaytarget-oauth2authorizationdata-userid

Type:

see

OAuthCredentialProviderProperty

class CfnGatewayTarget.OAuthCredentialProviderProperty(*, provider_arn, scopes, custom_parameters=None, default_return_url=None, grant_type=None)

Bases: object

The OAuth credential provider for the gateway target.

Parameters:

• provider_arn (str) – The provider ARN for the gateway target.

• scopes (Sequence[str]) – The OAuth credential provider scopes.

• 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])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html

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 import aws_bedrockagentcore as bedrockagentcore

o_auth_credential_provider_property = bedrockagentcore.CfnGatewayTarget.OAuthCredentialProviderProperty(
    provider_arn="providerArn",
    scopes=["scopes"],

    # the properties below are optional
    custom_parameters={
        "custom_parameters_key": "customParameters"
    },
    default_return_url="defaultReturnUrl",
    grant_type="grantType"
)

Attributes

custom_parameters

The OAuth credential provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-customparameters

default_return_url

Return URL for OAuth callback.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-defaultreturnurl

grant_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-granttype

Type:

see

provider_arn

The provider ARN for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-providerarn

scopes

The OAuth credential provider scopes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-oauthcredentialprovider.html#cfn-bedrockagentcore-gatewaytarget-oauthcredentialprovider-scopes

PrivateEndpointProperty

class CfnGatewayTarget.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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-privateendpoint.html

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 import aws_bedrockagentcore as bedrockagentcore

private_endpoint_property = bedrockagentcore.CfnGatewayTarget.PrivateEndpointProperty(
    managed_vpc_resource=bedrockagentcore.CfnGatewayTarget.ManagedVpcResourceProperty(
        endpoint_ip_address_type="endpointIpAddressType",
        subnet_ids=["subnetIds"],
        vpc_identifier="vpcIdentifier",

        # the properties below are optional
        routing_domain="routingDomain",
        security_group_ids=["securityGroupIds"]
    ),
    self_managed_lattice_resource=bedrockagentcore.CfnGatewayTarget.SelfManagedLatticeResourceProperty(
        resource_configuration_identifier="resourceConfigurationIdentifier"
    )
)

Attributes

managed_vpc_resource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-privateendpoint.html#cfn-bedrockagentcore-gatewaytarget-privateendpoint-managedvpcresource

Type:

see

self_managed_lattice_resource

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-privateendpoint.html#cfn-bedrockagentcore-gatewaytarget-privateendpoint-selfmanagedlatticeresource

Type:

see

RuntimeTargetConfigurationProperty

class CfnGatewayTarget.RuntimeTargetConfigurationProperty(*, arn, qualifier=None)

Bases: object

Parameters:

• arn (str)

• qualifier (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-runtimetargetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

runtime_target_configuration_property = bedrockagentcore.CfnGatewayTarget.RuntimeTargetConfigurationProperty(
    arn="arn",

    # the properties below are optional
    qualifier="qualifier"
)

Attributes

arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-runtimetargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-runtimetargetconfiguration-arn

Type:

see

qualifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-runtimetargetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-runtimetargetconfiguration-qualifier

Type:

see

S3ConfigurationProperty

class CfnGatewayTarget.S3ConfigurationProperty(*, bucket_owner_account_id=None, uri=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html

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 import aws_bedrockagentcore as bedrockagentcore

s3_configuration_property = bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
    bucket_owner_account_id="bucketOwnerAccountId",
    uri="uri"
)

Attributes

bucket_owner_account_id

The S3 configuration bucket owner account ID for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-bucketowneraccountid

uri

The configuration URI for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-s3configuration.html#cfn-bedrockagentcore-gatewaytarget-s3configuration-uri

SchemaDefinitionProperty

class CfnGatewayTarget.SchemaDefinitionProperty(*, type, description=None, items=None, properties=None, required=None)

Bases: object

The schema definition for the gateway target.

Parameters:

• type (str) – The scheme definition type for the gateway target.

• 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

schema_definition_property = bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
    type="type",

    # the properties below are optional
    description="description",
    items=schema_definition_property_,
    properties={
        "properties_key": schema_definition_property_
    },
    required=["required"]
)

Attributes

description

The workload identity details for the gateway.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description

items

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items

Type:

see

properties

The schema definition properties for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties

required

The schema definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required

type

The scheme definition type for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type

SelfManagedLatticeResourceProperty

class CfnGatewayTarget.SelfManagedLatticeResourceProperty(*, resource_configuration_identifier)

Bases: object

Parameters:

resource_configuration_identifier (str)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-selfmanagedlatticeresource.html

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 import aws_bedrockagentcore as bedrockagentcore

self_managed_lattice_resource_property = bedrockagentcore.CfnGatewayTarget.SelfManagedLatticeResourceProperty(
    resource_configuration_identifier="resourceConfigurationIdentifier"
)

Attributes

resource_configuration_identifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-selfmanagedlatticeresource.html#cfn-bedrockagentcore-gatewaytarget-selfmanagedlatticeresource-resourceconfigurationidentifier

Type:

see

TargetConfigurationProperty

class CfnGatewayTarget.TargetConfigurationProperty(*, http=None, mcp=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

target_configuration_property = bedrockagentcore.CfnGatewayTarget.TargetConfigurationProperty(
    http=bedrockagentcore.CfnGatewayTarget.HttpTargetConfigurationProperty(
        agentcore_runtime=bedrockagentcore.CfnGatewayTarget.RuntimeTargetConfigurationProperty(
            arn="arn",

            # the properties below are optional
            qualifier="qualifier"
        )
    ),
    mcp=bedrockagentcore.CfnGatewayTarget.McpTargetConfigurationProperty(
        api_gateway=bedrockagentcore.CfnGatewayTarget.ApiGatewayTargetConfigurationProperty(
            api_gateway_tool_configuration=bedrockagentcore.CfnGatewayTarget.ApiGatewayToolConfigurationProperty(
                tool_filters=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolFilterProperty(
                    filter_path="filterPath",
                    methods=["methods"]
                )],

                # the properties below are optional
                tool_overrides=[bedrockagentcore.CfnGatewayTarget.ApiGatewayToolOverrideProperty(
                    method="method",
                    name="name",
                    path="path",

                    # the properties below are optional
                    description="description"
                )]
            ),
            rest_api_id="restApiId",
            stage="stage"
        ),
        lambda_=bedrockagentcore.CfnGatewayTarget.McpLambdaTargetConfigurationProperty(
            lambda_arn="lambdaArn",
            tool_schema=bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
                inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
                    description="description",
                    input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                        type="type",

                        # the properties below are optional
                        description="description",
                        items=schema_definition_property_,
                        properties={
                            "properties_key": schema_definition_property_
                        },
                        required=["required"]
                    ),
                    name="name",

                    # the properties below are optional
                    output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
                        type="type",

                        # the properties below are optional
                        description="description",
                        items=schema_definition_property_,
                        properties={
                            "properties_key": schema_definition_property_
                        },
                        required=["required"]
                    )
                )],
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            )
        ),
        mcp_server=bedrockagentcore.CfnGatewayTarget.McpServerTargetConfigurationProperty(
            endpoint="endpoint",

            # the properties below are optional
            listing_mode="listingMode",
            mcp_tool_schema=bedrockagentcore.CfnGatewayTarget.McpToolSchemaConfigurationProperty(
                inline_payload="inlinePayload",
                s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                    bucket_owner_account_id="bucketOwnerAccountId",
                    uri="uri"
                )
            ),
            resource_priority=123
        ),
        open_api_schema=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
            inline_payload="inlinePayload",
            s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                bucket_owner_account_id="bucketOwnerAccountId",
                uri="uri"
            )
        ),
        smithy_model=bedrockagentcore.CfnGatewayTarget.ApiSchemaConfigurationProperty(
            inline_payload="inlinePayload",
            s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
                bucket_owner_account_id="bucketOwnerAccountId",
                uri="uri"
            )
        )
    )
)

Attributes

http

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-http

Type:

see

mcp

The target configuration definition for MCP.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-targetconfiguration.html#cfn-bedrockagentcore-gatewaytarget-targetconfiguration-mcp

ToolDefinitionProperty

class CfnGatewayTarget.ToolDefinitionProperty(*, description, input_schema, name, output_schema=None)

Bases: object

The tool definition for the gateway.

Parameters:

• description (str)

• input_schema (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any]]) – The input schema for the gateway target.

• name (str) – The tool name.

• output_schema (Union[IResolvable, SchemaDefinitionProperty, Dict[str, Any], None]) – The tool definition output schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

tool_definition_property = bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
    description="description",
    input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
        type="type",

        # the properties below are optional
        description="description",
        items=schema_definition_property_,
        properties={
            "properties_key": schema_definition_property_
        },
        required=["required"]
    ),
    name="name",

    # the properties below are optional
    output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
        type="type",

        # the properties below are optional
        description="description",
        items=schema_definition_property_,
        properties={
            "properties_key": schema_definition_property_
        },
        required=["required"]
    )
)

Attributes

description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description

Type:

see

input_schema

The input schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema

name

The tool name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name

output_schema

The tool definition output schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema

ToolSchemaProperty

class CfnGatewayTarget.ToolSchemaProperty(*, inline_payload=None, s3=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html

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 import aws_bedrockagentcore as bedrockagentcore

# schema_definition_property_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty

tool_schema_property = bedrockagentcore.CfnGatewayTarget.ToolSchemaProperty(
    inline_payload=[bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty(
        description="description",
        input_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
            type="type",

            # the properties below are optional
            description="description",
            items=schema_definition_property_,
            properties={
                "properties_key": schema_definition_property_
            },
            required=["required"]
        ),
        name="name",

        # the properties below are optional
        output_schema=bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty(
            type="type",

            # the properties below are optional
            description="description",
            items=schema_definition_property_,
            properties={
                "properties_key": schema_definition_property_
            },
            required=["required"]
        )
    )],
    s3=bedrockagentcore.CfnGatewayTarget.S3ConfigurationProperty(
        bucket_owner_account_id="bucketOwnerAccountId",
        uri="uri"
    )
)

Attributes

inline_payload

The inline payload for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-inlinepayload

s3

The S3 tool schema for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-toolschema.html#cfn-bedrockagentcore-gatewaytarget-toolschema-s3