S3ApiDefinition

class aws_cdk.aws_apigateway.S3ApiDefinition(bucket, key, object_version=None)

Bases: aws_cdk.aws_apigateway.ApiDefinition

(experimental) OpenAPI specification from an S3 archive.

Stability

experimental

Parameters
  • bucket (IBucket) –

  • key (str) –

  • object_version (Optional[str]) –

Stability

experimental

Methods

bind(_scope)

(experimental) Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.

Parameters

_scope (Construct) –

Stability

experimental

Return type

ApiDefinitionConfig

Static Methods

classmethod from_asset(file, *, readers=None, source_hash=None, exclude=None, follow=None, ignore_mode=None, asset_hash=None, asset_hash_type=None, bundling=None)

(experimental) Loads the API specification from a local disk asset.

Parameters
  • file (str) –

  • readers (Optional[List[IGrantable]]) – (experimental) A list of principals that should be able to read this asset from S3. You can use asset.grantRead(principal) to grant read permissions later. Default: - No principals that can read file asset.

  • source_hash (Optional[str]) – (deprecated) Custom hash to use when identifying the specific version of the asset. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the source hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated. Default: - automatically calculate source hash based on the contents of the source file or directory.

  • exclude (Optional[List[str]]) – (deprecated) Glob patterns to exclude from the copy. Default: nothing is excluded

  • follow (Optional[FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never

  • ignore_mode (Optional[IgnoreMode]) – (deprecated) The ignore behavior to use for exclude patterns. Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the ‘

  • asset_hash (Optional[str]) – Specify a custom hash for this asset. If assetHashType is set it must be set to AssetHashType.CUSTOM. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on assetHashType

  • asset_hash_type (Optional[AssetHashType]) – Specifies the type of hash to calculate for this asset. If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM. Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

  • bundling (Optional[BundlingOptions]) – (experimental) Bundle the asset by executing a command in a Docker container. The asset path will be mounted at /asset-input. The Docker container is responsible for putting content at /asset-output. The content at /asset-output will be zipped and used as the final asset. Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise

Stability

experimental

Return type

AssetApiDefinition

classmethod from_bucket(bucket, key, object_version=None)

(experimental) Creates an API definition from a specification file in an S3 bucket.

Parameters
  • bucket (IBucket) –

  • key (str) –

  • object_version (Optional[str]) –

Stability

experimental

Return type

S3ApiDefinition

classmethod from_inline(definition)

(experimental) Create an API definition from an inline object.

The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0

Parameters

definition (Any) –

Stability

experimental

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
ApiDefinition.from_inline(
    openapi="3.0.2",
    paths={
        "/pets": {
            "get": {
                "responses": {
                    "200": {
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Empty"
                                }
                            }
                        }
                    }
                },
                "x-amazon-apigateway-integration": {
                    "responses": {
                        "default": {
                            "status_code": "200"
                        }
                    },
                    "request_templates": {
                        "application/json": "{"statusCode": 200}"
                    },
                    "passthrough_behavior": "when_no_match",
                    "type": "mock"
                }
            }
        }
    },
    components={
        "schemas": {
            "Empty": {
                "title": "Empty Schema",
                "type": "object"
            }
        }
    }
)
Return type

InlineApiDefinition