RestApiS3LocationArgs

data class RestApiS3LocationArgs(val bucket: Output<String>? = null, val eTag: Output<String>? = null, val key: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<RestApiS3LocationArgs>

`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.

Constructors

Link copied to clipboard
constructor(bucket: Output<String>? = null, eTag: Output<String>? = null, key: Output<String>? = null, version: Output<String>? = null)

Properties

Link copied to clipboard
val bucket: Output<String>? = null

The name of the S3 bucket where the OpenAPI file is stored.

Link copied to clipboard
val eTag: Output<String>? = null

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.

Link copied to clipboard
val key: Output<String>? = null

The file name of the OpenAPI file (Amazon S3 object name).

Link copied to clipboard
val version: Output<String>? = null

For versioning-enabled buckets, a specific version of the OpenAPI file.

Functions

Link copied to clipboard
open override fun toJava(): RestApiS3LocationArgs