Package software.amazon.awscdk.services.apigateway

Interface ApiDefinitionS3Location

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiDefinitionS3Location.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:22.891Z")
@Stability(Stable)
public interface ApiDefinitionS3Location
extends software.amazon.jsii.JsiiSerializable

S3 location of the API definition 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.services.apigateway.*;
 ApiDefinitionS3Location apiDefinitionS3Location = ApiDefinitionS3Location.builder()
         .bucket("bucket")
         .key("key")
         // the properties below are optional
         .version("version")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiDefinitionS3Location.Builder	builder()
String	getBucket()	The S3 bucket.
String	getKey()	The S3 key.
default String	getVersion()	An optional version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
String getBucket()

The S3 bucket.

getKey

@Stability(Stable)
@NotNull
String getKey()

The S3 key.

getVersion

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

An optional version.

Default: - latest version

builder

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

Returns:

a ApiDefinitionS3Location.Builder of ApiDefinitionS3Location