Package software.amazon.awscdk.services.apigateway

Class CfnRestApi.S3LocationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnRestApi.S3LocationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRestApi.S3LocationProperty>

Enclosing interface:

CfnRestApi.S3LocationProperty

@Stability(Stable)
public static final class CfnRestApi.S3LocationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRestApi.S3LocationProperty>

A builder for CfnRestApi.S3LocationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRestApi.S3LocationProperty.Builder	bucket(String bucket)	Sets the value of CfnRestApi.S3LocationProperty.getBucket()
CfnRestApi.S3LocationProperty	build()	Builds the configured instance.
CfnRestApi.S3LocationProperty.Builder	eTag(String eTag)	Sets the value of CfnRestApi.S3LocationProperty.getETag()
CfnRestApi.S3LocationProperty.Builder	key(String key)	Sets the value of CfnRestApi.S3LocationProperty.getKey()
CfnRestApi.S3LocationProperty.Builder	version(String version)	Sets the value of CfnRestApi.S3LocationProperty.getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

bucket

@Stability(Stable)
public CfnRestApi.S3LocationProperty.Builder bucket(String bucket)

Sets the value of CfnRestApi.S3LocationProperty.getBucket()

Parameters:

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

Returns:

this

eTag

@Stability(Stable)
public CfnRestApi.S3LocationProperty.Builder eTag(String eTag)

Sets the value of CfnRestApi.S3LocationProperty.getETag()

Parameters:

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

Returns:

this

key

@Stability(Stable)
public CfnRestApi.S3LocationProperty.Builder key(String key)

Sets the value of CfnRestApi.S3LocationProperty.getKey()

Parameters:

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

Returns:

this

version

@Stability(Stable)
public CfnRestApi.S3LocationProperty.Builder version(String version)

Sets the value of CfnRestApi.S3LocationProperty.getVersion()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnRestApi.S3LocationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRestApi.S3LocationProperty>

Returns:

a new instance of CfnRestApi.S3LocationProperty

Throws:

NullPointerException - if any required attribute was not provided