Interface CfnRestApi.S3LocationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRestApi.S3LocationProperty.Jsii$Proxy
- Enclosing class:
CfnRestApi
@Stability(Stable)
public static interface CfnRestApi.S3LocationProperty
extends software.amazon.jsii.JsiiSerializable
S3Location
is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.
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.*; S3LocationProperty s3LocationProperty = S3LocationProperty.builder() .bucket("bucket") .eTag("eTag") .key("key") .version("version") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRestApi.S3LocationProperty
static final class
An implementation forCfnRestApi.S3LocationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The name of the S3 bucket where the OpenAPI file is stored.default String
getETag()
The Amazon S3 ETag (a file checksum) of the OpenAPI file.default String
getKey()
The file name of the OpenAPI file (Amazon S3 object name).default String
For versioning-enabled buckets, a specific version of the OpenAPI file.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBucket
The name of the S3 bucket where the OpenAPI file is stored.- See Also:
-
getETag
The Amazon S3 ETag (a file checksum) of the OpenAPI file.If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
- See Also:
-
getKey
The file name of the OpenAPI file (Amazon S3 object name).- See Also:
-
getVersion
For versioning-enabled buckets, a specific version of the OpenAPI file.- See Also:
-
builder
-