software.amazon.awscdk.services.apigateway

Interface ApiDefinitionConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiDefinitionConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:41.048Z")
 @Stability(value=Experimental)
public interface ApiDefinitionConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Post-Binding Configuration for a CDK construct.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Object inlineDefinition;
 ApiDefinitionConfig apiDefinitionConfig = ApiDefinitionConfig.builder()
         .inlineDefinition(inlineDefinition)
         .s3Location(ApiDefinitionS3Location.builder()
                 .bucket("bucket")
                 .key("key")
                 // the properties below are optional
                 .version("version")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiDefinitionConfig.Builder A builder for ApiDefinitionConfig
static class	ApiDefinitionConfig.Jsii$Proxy An implementation for ApiDefinitionConfig

Method Summary

Modifier and Type	Method and Description
static ApiDefinitionConfig.Builder	builder()
default Object	getInlineDefinition() (experimental) Inline specification (mutually exclusive with `s3Location`).
default ApiDefinitionS3Location	getS3Location() (experimental) The location of the specification in S3 (mutually exclusive with `inlineDefinition`).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInlineDefinition

@Stability(value=Experimental)
 @Nullable
default Object getInlineDefinition()

(experimental) Inline specification (mutually exclusive with `s3Location`).

Default: - API definition is not defined inline

getS3Location

@Stability(value=Experimental)
 @Nullable
default ApiDefinitionS3Location getS3Location()

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

Default: - API definition is not an S3 location

builder

@Stability(value=Experimental)
static ApiDefinitionConfig.Builder builder()

Returns:

a ApiDefinitionConfig.Builder of ApiDefinitionConfig