Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApi.BodyS3LocationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.BodyS3LocationProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.BodyS3LocationProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@Nullable
default String getBucket()

The S3 bucket that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket

getEtag

@Stability(Stable)
@Nullable
default String getEtag()

The Etag of the S3 object.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag

getKey

@Stability(Stable)
@Nullable
default String getKey()

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

The version of the S3 object.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version

builder

@Stability(Stable)
static CfnApi.BodyS3LocationProperty.Builder builder()

Returns:

a CfnApi.BodyS3LocationProperty.Builder of CfnApi.BodyS3LocationProperty