GatewayTargetOpenApiProps

class aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetOpenApiProps(*, description=None, gateway_target_name=None, api_schema, gateway, credential_provider_configurations=None, validate_open_api_schema=None)

Bases: GatewayTargetCommonProps

(experimental) Properties for creating an OpenAPI-based Gateway Target.

Parameters:

  • description (Optional[str]) – (experimental) Optional description for the gateway target The description can have up to 200 characters. Default: - No description

  • gateway_target_name (Optional[str]) – (experimental) The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$. Default: - auto generate

  • api_schema (ApiSchema) – (experimental) The OpenAPI schema defining the API.

  • gateway (IGateway) – (experimental) The gateway this target belongs to.

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for authentication OpenAPI targets support API key and OAuth authentication (not IAM). Default: - If not provided, defaults to IAM role which will fail at runtime

  • validate_open_api_schema (Optional[bool]) – (experimental) Whether to validate the OpenAPI schema (only applies to inline schemas) Note: Validation is only performed for inline schemas during CDK synthesis. S3 and asset-based schemas cannot be validated at synthesis time. Default: true

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# api_schema: bedrock_agentcore_alpha.ApiSchema
# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# gateway: bedrock_agentcore_alpha.Gateway

gateway_target_open_api_props = bedrock_agentcore_alpha.GatewayTargetOpenApiProps(
    api_schema=api_schema,
    gateway=gateway,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName",
    validate_open_api_schema=False
)

Attributes

api_schema

(experimental) The OpenAPI schema defining the API.

Stability:

experimental

credential_provider_configurations

(experimental) Credential providers for authentication OpenAPI targets support API key and OAuth authentication (not IAM).

Default:

  • If not provided, defaults to IAM role which will fail at runtime

Stability:

experimental

description

(experimental) Optional description for the gateway target The description can have up to 200 characters.

Default:

  • No description

Stability:

experimental

gateway

(experimental) The gateway this target belongs to.

Stability:

experimental

gateway_target_name

^([0-9a-zA-Z][-]?){1,100}$.

Default:

  • auto generate

Stability:

experimental

Type:

(experimental) The name of the gateway target The name must be unique within the gateway Pattern

validate_open_api_schema

Validation is only performed for inline schemas during CDK synthesis.

S3 and asset-based schemas cannot be validated at synthesis time.

Default:

true

Stability:

experimental

Type:

(experimental) Whether to validate the OpenAPI schema (only applies to inline schemas) Note