software.amazon.awscdk.services.apigateway

Class CfnMethod.MethodResponseProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnMethod.MethodResponseProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMethod.MethodResponseProperty>

Enclosing interface:

CfnMethod.MethodResponseProperty

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

A builder for CfnMethod.MethodResponseProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnMethod.MethodResponseProperty	build() Builds the configured instance.
CfnMethod.MethodResponseProperty.Builder	responseModels(IResolvable responseModels) Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()
CfnMethod.MethodResponseProperty.Builder	responseModels(Map<String,String> responseModels) Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()
CfnMethod.MethodResponseProperty.Builder	responseParameters(IResolvable responseParameters) Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()
CfnMethod.MethodResponseProperty.Builder	responseParameters(Map<String,? extends Object> responseParameters) Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()
CfnMethod.MethodResponseProperty.Builder	statusCode(String statusCode) Sets the value of CfnMethod.MethodResponseProperty.getStatusCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

statusCode

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty.Builder statusCode(String statusCode)

Sets the value of CfnMethod.MethodResponseProperty.getStatusCode()

Parameters:

statusCode - The method response's status code, which you map to an [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) . This parameter is required.

Returns:

this

responseModels

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty.Builder responseModels(IResolvable responseModels)

Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()

Parameters:

responseModels - The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

Returns:

this

responseModels

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty.Builder responseModels(Map<String,String> responseModels)

Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()

Parameters:

responseModels - The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty.Builder responseParameters(IResolvable responseParameters)

Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()

Parameters:

responseParameters - Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header. *name* , where name is a valid, unique header name. The Boolean specifies whether a parameter is required.

Returns:

this

responseParameters

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty.Builder responseParameters(Map<String,? extends Object> responseParameters)

Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()

Parameters:

responseParameters - Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header. *name* , where name is a valid, unique header name. The Boolean specifies whether a parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnMethod.MethodResponseProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnMethod.MethodResponseProperty>

Returns:

a new instance of CfnMethod.MethodResponseProperty

Throws:

NullPointerException - if any required attribute was not provided