software.amazon.awscdk.services.apigatewayv2

Interface CfnApi.BodyS3LocationProperty

All Known Implementing Classes:

CfnApi.BodyS3LocationProperty.Jsii$Proxy

Enclosing class:

CfnApi

public static interface CfnApi.BodyS3LocationProperty

The `BodyS3Location` property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.

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.apigatewayv2.*;
 BodyS3LocationProperty bodyS3LocationProperty = BodyS3LocationProperty.builder()
         .bucket("bucket")
         .etag("etag")
         .key("key")
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApi.BodyS3LocationProperty.Builder	builder()
default java.lang.String	getBucket() The S3 bucket that contains the OpenAPI definition to import.
default java.lang.String	getEtag() The Etag of the S3 object.
default java.lang.String	getKey() The key of the S3 object.
default java.lang.String	getVersion() The version of the S3 object.

Method Detail

getBucket

default java.lang.String getBucket()

The S3 bucket that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.

getEtag

default java.lang.String getEtag()

The Etag of the S3 object.

getKey

default java.lang.String getKey()

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

getVersion

default java.lang.String getVersion()

The version of the S3 object.

builder

static CfnApi.BodyS3LocationProperty.Builder builder()

Returns:

a CfnApi.BodyS3LocationProperty.Builder of CfnApi.BodyS3LocationProperty