ApiDefinitionConfig

class aws_cdk.aws_apigateway.ApiDefinitionConfig(*, inline_definition=None, s3_location=None)

Bases: object

Post-Binding Configuration for a CDK construct.

Parameters
  • inline_definition (Optional[Any]) – Inline specification (mutually exclusive with s3Location). Default: - API definition is not defined inline

  • s3_location (Optional[ApiDefinitionS3Location]) – The location of the specification in S3 (mutually exclusive with inlineDefinition). Default: - API definition is not an S3 location

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_apigateway as apigateway

# inline_definition: Any

api_definition_config = apigateway.ApiDefinitionConfig(
    inline_definition=inline_definition,
    s3_location=apigateway.ApiDefinitionS3Location(
        bucket="bucket",
        key="key",

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

Attributes

inline_definition

Inline specification (mutually exclusive with s3Location).

Default
  • API definition is not defined inline

Return type

Any

s3_location

The location of the specification in S3 (mutually exclusive with inlineDefinition).

Default
  • API definition is not an S3 location

Return type

Optional[ApiDefinitionS3Location]