CfnGatewayPropsMixin

class aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnGatewayPropsMixin(props, *, strategy=None)

Bases: Mixin

Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.

For more information about creating a gateway, see Set up an Amazon Bedrock AgentCore gateway .

See the Properties section below for descriptions of both the required and optional properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gateway.html
CloudformationResource:: AWS::BedrockAgentCore::Gateway
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

cfn_gateway_props_mixin = bedrockagentcore_mixins.CfnGatewayPropsMixin(bedrockagentcore_mixins.CfnGatewayMixinProps(
    authorizer_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.AuthorizerConfigurationProperty(
        custom_jwt_authorizer=bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty(
            allowed_audience=["allowedAudience"],
            allowed_clients=["allowedClients"],
            discovery_url="discoveryUrl"
        )
    ),
    authorizer_type="authorizerType",
    description="description",
    exception_level="exceptionLevel",
    kms_key_arn="kmsKeyArn",
    name="name",
    protocol_configuration=bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty(
        mcp=bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(
            instructions="instructions",
            search_type="searchType",
            supported_versions=["supportedVersions"]
        )
    ),
    protocol_type="protocolType",
    role_arn="roleArn",
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::BedrockAgentCore::Gateway.

Parameters:

props (Union[CfnGatewayMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['authorizerConfiguration', 'authorizerType', 'description', 'exceptionLevel', 'kmsKeyArn', 'name', 'protocolConfiguration', 'protocolType', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AuthorizerConfigurationProperty

class CfnGatewayPropsMixin.AuthorizerConfigurationProperty(*, custom_jwt_authorizer=None)

Bases: object

Parameters:: custom_jwt_authorizer (Union[IResolvable, CustomJWTAuthorizerConfigurationProperty, Dict[str, Any], None]) – The authorizer configuration for the gateway.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

authorizer_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.AuthorizerConfigurationProperty(
    custom_jwt_authorizer=bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty(
        allowed_audience=["allowedAudience"],
        allowed_clients=["allowedClients"],
        discovery_url="discoveryUrl"
    )
)

Attributes

custom_jwt_authorizer

The authorizer configuration for the gateway.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-authorizerconfiguration.html#cfn-bedrockagentcore-gateway-authorizerconfiguration-customjwtauthorizer

CustomJWTAuthorizerConfigurationProperty

class CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty(*, allowed_audience=None, allowed_clients=None, discovery_url=None)

Bases: object

Parameters:

allowed_audience (Optional[Sequence[str]]) – The allowed audience authorized for the gateway target.
allowed_clients (Optional[Sequence[str]])
discovery_url (Optional[str]) – The discovery URL for the authorizer configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

custom_jWTAuthorizer_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.CustomJWTAuthorizerConfigurationProperty(
    allowed_audience=["allowedAudience"],
    allowed_clients=["allowedClients"],
    discovery_url="discoveryUrl"
)

Attributes

allowed_audience

The allowed audience authorized for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedaudience

allowed_clients

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-allowedclients

Type:: see

discovery_url

The discovery URL for the authorizer configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-gateway-customjwtauthorizerconfiguration-discoveryurl

GatewayProtocolConfigurationProperty

class CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty(*, mcp=None)

Bases: object

The protocol configuration.

Parameters:: mcp (Union[IResolvable, MCPGatewayConfigurationProperty, Dict[str, Any], None]) – The gateway protocol configuration for MCP.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

gateway_protocol_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.GatewayProtocolConfigurationProperty(
    mcp=bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(
        instructions="instructions",
        search_type="searchType",
        supported_versions=["supportedVersions"]
    )
)

Attributes

mcp

The gateway protocol configuration for MCP.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-gatewayprotocolconfiguration.html#cfn-bedrockagentcore-gateway-gatewayprotocolconfiguration-mcp

MCPGatewayConfigurationProperty

class CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(*, instructions=None, search_type=None, supported_versions=None)

Bases: object

The gateway configuration for MCP.

Parameters:

instructions (Optional[str])
search_type (Optional[str]) – The MCP gateway configuration search type.
supported_versions (Optional[Sequence[str]]) – The supported versions for the MCP configuration for the gateway target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

m_cPGateway_configuration_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.MCPGatewayConfigurationProperty(
    instructions="instructions",
    search_type="searchType",
    supported_versions=["supportedVersions"]
)

Attributes

instructions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-instructions

Type:: see

search_type

The MCP gateway configuration search type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-searchtype

supported_versions

The supported versions for the MCP configuration for the gateway target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-mcpgatewayconfiguration.html#cfn-bedrockagentcore-gateway-mcpgatewayconfiguration-supportedversions

WorkloadIdentityDetailsProperty

class CfnGatewayPropsMixin.WorkloadIdentityDetailsProperty(*, workload_identity_arn=None)

Bases: object

The workload identity details for the gateway.

Parameters:: workload_identity_arn (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.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.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

workload_identity_details_property = bedrockagentcore_mixins.CfnGatewayPropsMixin.WorkloadIdentityDetailsProperty(
    workload_identity_arn="workloadIdentityArn"
)

Attributes

workload_identity_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gateway-workloadidentitydetails.html#cfn-bedrockagentcore-gateway-workloadidentitydetails-workloadidentityarn

Type:: see