CfnGatewayProps

class aws_cdk.aws_bedrockagentcore.CfnGatewayProps(*, authorizer_type, name, protocol_type, role_arn, authorizer_configuration=None, description=None, exception_level=None, kms_key_arn=None, protocol_configuration=None, tags=None)

Bases: object

Properties for defining a CfnGateway.

Parameters:

authorizer_type (str) – The authorizer type for the gateway.
name (str) – The name for the gateway.
protocol_type (str) – The protocol type for the gateway target.
role_arn (str)
authorizer_configuration (Union[IResolvable, AuthorizerConfigurationProperty, Dict[str, Any], None])
description (Optional[str]) – The description for the gateway.
exception_level (Optional[str]) – The exception level for the gateway.
kms_key_arn (Optional[str]) – The KMS key ARN for the gateway.
protocol_configuration (Union[IResolvable, GatewayProtocolConfigurationProperty, Dict[str, Any], None]) – The protocol configuration for the gateway target.
tags (Optional[Mapping[str, str]]) – The tags for the gateway.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.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

cfn_gateway_props = bedrockagentcore.CfnGatewayProps(
    authorizer_type="authorizerType",
    name="name",
    protocol_type="protocolType",
    role_arn="roleArn",

    # the properties below are optional
    authorizer_configuration=bedrockagentcore.CfnGateway.AuthorizerConfigurationProperty(
        custom_jwt_authorizer=bedrockagentcore.CfnGateway.CustomJWTAuthorizerConfigurationProperty(
            discovery_url="discoveryUrl",

            # the properties below are optional
            allowed_audience=["allowedAudience"],
            allowed_clients=["allowedClients"]
        )
    ),
    description="description",
    exception_level="exceptionLevel",
    kms_key_arn="kmsKeyArn",
    protocol_configuration=bedrockagentcore.CfnGateway.GatewayProtocolConfigurationProperty(
        mcp=bedrockagentcore.CfnGateway.MCPGatewayConfigurationProperty(
            instructions="instructions",
            search_type="searchType",
            supported_versions=["supportedVersions"]
        )
    ),
    tags={
        "tags_key": "tags"
    }
)