Bases: ApiDefinition
OpenAPI specification from an S3 archive.
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 import aws_cdk.aws_s3 as s3 # bucket: s3.Bucket s3_api_definition = apigateway.S3ApiDefinition(bucket, "key", "objectVersion")
bucket (IBucket)
key (str)
object_version (Optional[str])
Methods
Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.
_scope (Construct)
Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.
Specifically itâs required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.
Static Methods
Loads the API specification from a local disk asset.
file (str)
readers (Optional[Sequence[IGrantable]]) â 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[Sequence[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 â
follow_symlinks (Optional[SymlinkFollowMode]) â A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
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 (Union[BundlingOptions, Dict[str, Any], None]) â Bundle the asset by executing a command in a Docker container or a custom bundling provider. 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
Creates an API definition from a specification file in an S3 bucket.
bucket (IBucket)
key (str)
object_version (Optional[str])
Create an API definition from an inline object.
The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
definition (Any)
Example:
apigateway.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"
}
}
}
})
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4