AddOpenApiTargetOptions

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

Bases: object

(experimental) Options for adding an OpenAPI target to a gateway.

Parameters:

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

  • credential_provider_configurations (Optional[Sequence[ICredentialProviderConfig]]) – (experimental) Credential providers for outbound authentication (OpenAPI targets use API Key or OAuth, not IAM). Default: - none (no credential configuration on the target; supply providers for secured backends)

  • description (Optional[str]) – (experimental) Optional description for the gateway target. Default: - No description

  • gateway_target_name (Optional[str]) – (experimental) The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen). Default: - auto generate

  • validate_open_api_schema (Optional[bool]) – (experimental) Whether to validate the OpenAPI schema or not Note: Validation is only performed for inline and asset-based schema and during CDK synthesis. S3 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

add_open_api_target_options = bedrock_agentcore_alpha.AddOpenApiTargetOptions(
    api_schema=api_schema,

    # 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 outbound authentication (OpenAPI targets use API Key or OAuth, not IAM).

Default:

  • none (no credential configuration on the target; supply providers for secured backends)

Stability:

experimental

description

(experimental) Optional description for the gateway target.

Default:

  • No description

Stability:

experimental

gateway_target_name

(experimental) The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Default:

  • auto generate

Stability:

experimental

validate_open_api_schema

Validation is only performed for inline and asset-based schema and during CDK synthesis.

S3 schemas cannot be validated at synthesis time.

Default:

true

Stability:

experimental

Type:

(experimental) Whether to validate the OpenAPI schema or not Note