software.amazon.awscdk.services.apigateway

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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.085Z")
 @Stability(value=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.*;
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.iam.*;
 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)
                 .network("network")
                 .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"))
         .followSymlinks(SymlinkFollowMode.NEVER)
         .ignoreMode(IgnoreMode.GLOB)
         .readers(List.of(grantable))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetApiDefinition.Builder A fluent builder for AssetApiDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetApiDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AssetApiDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	AssetApiDefinition(String path)
	AssetApiDefinition(String path, AssetOptions options)

Method Summary

Modifier and Type	Method and Description
ApiDefinitionConfig	bind(software.constructs.Construct scope) Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.
void	bindAfterCreate(software.constructs.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 Detail

AssetApiDefinition

protected AssetApiDefinition(software.amazon.jsii.JsiiObjectRef objRef)

AssetApiDefinition

protected AssetApiDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

AssetApiDefinition

@Stability(value=Stable)
public AssetApiDefinition(@NotNull
                                                   String path,
                                                   @Nullable
                                                   AssetOptions options)

Parameters:

path - This parameter is required.

options -

AssetApiDefinition

@Stability(value=Stable)
public AssetApiDefinition(@NotNull
                                                   String path)

Parameters:

path - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public ApiDefinitionConfig bind(@NotNull
                                                                   software.constructs.Construct scope)

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

Specified by:

bind in class ApiDefinition

Parameters:

scope - This parameter is required.

bindAfterCreate

@Stability(value=Stable)
public void bindAfterCreate(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     IRestApi restApi)

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 class ApiDefinition

Parameters:

scope - This parameter is required.

restApi - This parameter is required.