Interface CfnApi.BodyS3LocationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnApi.BodyS3LocationProperty extends
The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 BodyS3LocationProperty bodyS3LocationProperty = BodyS3LocationProperty.builder()
  • 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.

    • getEtag

      @Stability(Stable) @Nullable default String getEtag()
      The Etag of the S3 object.
    • getKey

      @Stability(Stable) @Nullable default String getKey()
      The key of the S3 object.

      Required if you specify a BodyS3Location for an API.

    • getVersion

      @Stability(Stable) @Nullable default String getVersion()
      The version of the S3 object.
    • builder

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