Package 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.97.0 (build 729de35)",
           date="2024-04-18T17:54:11.750Z")
@Stability(Stable)
public interface ApiDefinitionConfig
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	ApiDefinitionConfig.Builder	A builder for ApiDefinitionConfig
static final class	ApiDefinitionConfig.Jsii$Proxy	An implementation for ApiDefinitionConfig

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInlineDefinition

@Stability(Stable)
@Nullable
default Object getInlineDefinition()

Inline specification (mutually exclusive with s3Location).

Default: - API definition is not defined inline

getS3Location

@Stability(Stable)
@Nullable
default ApiDefinitionS3Location getS3Location()

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

Default: - API definition is not an S3 location

builder

@Stability(Stable)
static ApiDefinitionConfig.Builder builder()

Returns:

a ApiDefinitionConfig.Builder of ApiDefinitionConfig