Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnModelPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnModelPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnModelPropsMixin>

Enclosing class:

CfnModelPropsMixin

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

A fluent builder for CfnModelPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnModelPropsMixin	build()
CfnModelPropsMixin.Builder	contentType(String contentType)	The content-type for the model.
static CfnModelPropsMixin.Builder	create()
static CfnModelPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnModelPropsMixin.Builder	description(String description)	The description of the model.
CfnModelPropsMixin.Builder	name(String name)	A name for the model.
CfnModelPropsMixin.Builder	restApiId(String restApiId)	The string identifier of the associated RestApi.
CfnModelPropsMixin.Builder	restApiId(IRestApiRef restApiId)	The string identifier of the associated RestApi.
CfnModelPropsMixin.Builder	schema(Object schema)	The schema for the model.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnModelPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnModelPropsMixin.Builder.

create

@Stability(Stable)
public static CfnModelPropsMixin.Builder create()

Returns:

a new instance of CfnModelPropsMixin.Builder.

contentType

@Stability(Stable)
public CfnModelPropsMixin.Builder contentType(String contentType)

The content-type for the model.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype

description

@Stability(Stable)
public CfnModelPropsMixin.Builder description(String description)

The description of the model.

Parameters:

description - The description of the model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description

name

@Stability(Stable)
public CfnModelPropsMixin.Builder name(String name)

A name for the model.

If you don't specify a name, 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name

restApiId

@Stability(Stable)
public CfnModelPropsMixin.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid

restApiId

@Stability(Stable)
public CfnModelPropsMixin.Builder restApiId(IRestApiRef restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid

schema

@Stability(Stable)
public CfnModelPropsMixin.Builder schema(Object schema)

The schema for the model.

For application/json models, this should be JSON schema draft 4 model. Do not include "* /" characters in the description of any properties because such "* /" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

Parameters:

schema - The schema for the model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema

build

@Stability(Stable)
public CfnModelPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnModelPropsMixin.