Class AssetApiDefinition
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.ApiDefinition
software.amazon.awscdk.services.apigateway.AssetApiDefinition
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:44.701Z")
@Stability(Stable)
public class AssetApiDefinition
extends ApiDefinition
OpenAPI specification from a local file.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.assets.*; import software.amazon.awscdk.services.apigateway.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.core.*; DockerImage dockerImage; IGrantable grantable; ILocalBundling localBundling; AssetApiDefinition assetApiDefinition = AssetApiDefinition.Builder.create("path") .assetHash("assetHash") .assetHashType(AssetHashType.SOURCE) .bundling(BundlingOptions.builder() .image(dockerImage) // the properties below are optional .command(List.of("command")) .entrypoint(List.of("entrypoint")) .environment(Map.of( "environmentKey", "environment")) .local(localBundling) .outputType(BundlingOutput.ARCHIVED) .securityOpt("securityOpt") .user("user") .volumes(List.of(DockerVolume.builder() .containerPath("containerPath") .hostPath("hostPath") // the properties below are optional .consistency(DockerVolumeConsistency.CONSISTENT) .build())) .workingDirectory("workingDirectory") .build()) .exclude(List.of("exclude")) .follow(FollowMode.NEVER) .followSymlinks(SymlinkFollowMode.NEVER) .ignoreMode(IgnoreMode.GLOB) .readers(List.of(grantable)) .sourceHash("sourceHash") .build();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionAssetApiDefinition
(String path) AssetApiDefinition
(String path, AssetOptions options) protected
AssetApiDefinition
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
AssetApiDefinition
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionCalled when the specification is initialized to allow this object to bind to the stack, add resources and have fun.void
bindAfterCreate
(Construct scope, IRestApi restApi) Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.Methods inherited from class software.amazon.awscdk.services.apigateway.ApiDefinition
fromAsset, fromAsset, fromBucket, fromBucket, fromInline
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
AssetApiDefinition
protected AssetApiDefinition(software.amazon.jsii.JsiiObjectRef objRef) -
AssetApiDefinition
protected AssetApiDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
AssetApiDefinition
- Parameters:
path
- This parameter is required.options
-
-
AssetApiDefinition
- Parameters:
path
- This parameter is required.
-
-
Method Details
-
bind
Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.- Specified by:
bind
in classApiDefinition
- Parameters:
scope
- This parameter is required.
-
bindAfterCreate
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.
- Overrides:
bindAfterCreate
in classApiDefinition
- Parameters:
scope
- This parameter is required.restApi
- This parameter is required.
-