software.amazon.awscdk.services.apigateway

Class CfnModel.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnModel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnModel>

Enclosing class:

CfnModel

@Stability(value=Stable)
public static final class CfnModel.Builder
extends Object
implements software.amazon.jsii.Builder<CfnModel>

A fluent builder for CfnModel.

Method Summary

Modifier and Type	Method and Description
CfnModel	build()
CfnModel.Builder	contentType(String contentType) The content type for the model.
static CfnModel.Builder	create(software.constructs.Construct scope, String id)
CfnModel.Builder	description(String description) A description that identifies this model.
CfnModel.Builder	name(String name) A name for the model.
CfnModel.Builder	restApiId(String restApiId) The ID of a REST API with which to associate this model.
CfnModel.Builder	schema(Object schema) The schema to use to transform data to one or more output formats.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnModel.Builder create(software.constructs.Construct scope,
                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnModel.Builder.

restApiId

@Stability(value=Stable)
public CfnModel.Builder restApiId(String restApiId)

The ID of a REST API with which to associate this model.

Parameters:

restApiId - The ID of a REST API with which to associate this model. This parameter is required.

Returns:

this

contentType

@Stability(value=Stable)
public CfnModel.Builder contentType(String contentType)

The content type for the model.

Parameters:

contentType - The content type for the model. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnModel.Builder description(String description)

A description that identifies this model.

Parameters:

description - A description that identifies this model. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnModel.Builder name(String name)

A name for the model.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

name - A name for the model. This parameter is required.

Returns:

this

schema

@Stability(value=Stable)
public CfnModel.Builder schema(Object schema)

The schema to use to transform data to one or more output formats.

Specify null ( {} ) if you don't want to specify a schema.

Parameters:

schema - The schema to use to transform data to one or more output formats. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnModel build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnModel>