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

Class CfnMethodMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMethodMixinProps>

Enclosing interface:

CfnMethodMixinProps

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

A builder for CfnMethodMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnMethodMixinProps.Builder	apiKeyRequired(Boolean apiKeyRequired)	Sets the value of CfnMethodMixinProps.getApiKeyRequired()
CfnMethodMixinProps.Builder	apiKeyRequired(IResolvable apiKeyRequired)	Sets the value of CfnMethodMixinProps.getApiKeyRequired()
CfnMethodMixinProps.Builder	authorizationScopes(List<String> authorizationScopes)	Sets the value of CfnMethodMixinProps.getAuthorizationScopes()
CfnMethodMixinProps.Builder	authorizationType(String authorizationType)	Sets the value of CfnMethodMixinProps.getAuthorizationType()
CfnMethodMixinProps.Builder	authorizerId(String authorizerId)	Sets the value of CfnMethodMixinProps.getAuthorizerId()
CfnMethodMixinProps.Builder	authorizerId(IAuthorizerRef authorizerId)	Sets the value of CfnMethodMixinProps.getAuthorizerId()
CfnMethodMixinProps	build()	Builds the configured instance.
CfnMethodMixinProps.Builder	httpMethod(String httpMethod)	Sets the value of CfnMethodMixinProps.getHttpMethod()
CfnMethodMixinProps.Builder	integration(CfnMethodPropsMixin.IntegrationProperty integration)	Sets the value of CfnMethodMixinProps.getIntegration()
CfnMethodMixinProps.Builder	integration(IResolvable integration)	Sets the value of CfnMethodMixinProps.getIntegration()
CfnMethodMixinProps.Builder	methodResponses(List<? extends Object> methodResponses)	Sets the value of CfnMethodMixinProps.getMethodResponses()
CfnMethodMixinProps.Builder	methodResponses(IResolvable methodResponses)	Sets the value of CfnMethodMixinProps.getMethodResponses()
CfnMethodMixinProps.Builder	operationName(String operationName)	Sets the value of CfnMethodMixinProps.getOperationName()
CfnMethodMixinProps.Builder	requestModels(Map<String,String> requestModels)	Sets the value of CfnMethodMixinProps.getRequestModels()
CfnMethodMixinProps.Builder	requestModels(IResolvable requestModels)	Sets the value of CfnMethodMixinProps.getRequestModels()
CfnMethodMixinProps.Builder	requestParameters(Map<String,? extends Object> requestParameters)	Sets the value of CfnMethodMixinProps.getRequestParameters()
CfnMethodMixinProps.Builder	requestParameters(IResolvable requestParameters)	Sets the value of CfnMethodMixinProps.getRequestParameters()
CfnMethodMixinProps.Builder	requestValidatorId(String requestValidatorId)	Sets the value of CfnMethodMixinProps.getRequestValidatorId()
CfnMethodMixinProps.Builder	requestValidatorId(IRequestValidatorRef requestValidatorId)	Sets the value of CfnMethodMixinProps.getRequestValidatorId()
CfnMethodMixinProps.Builder	resourceId(String resourceId)	Sets the value of CfnMethodMixinProps.getResourceId()
CfnMethodMixinProps.Builder	resourceId(IResourceRef resourceId)	Sets the value of CfnMethodMixinProps.getResourceId()
CfnMethodMixinProps.Builder	restApiId(String restApiId)	Sets the value of CfnMethodMixinProps.getRestApiId()
CfnMethodMixinProps.Builder	restApiId(IRestApiRef restApiId)	Sets the value of CfnMethodMixinProps.getRestApiId()

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

apiKeyRequired

@Stability(Stable)
public CfnMethodMixinProps.Builder apiKeyRequired(Boolean apiKeyRequired)

Sets the value of CfnMethodMixinProps.getApiKeyRequired()

Parameters:

apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Returns:

this

apiKeyRequired

@Stability(Stable)
public CfnMethodMixinProps.Builder apiKeyRequired(IResolvable apiKeyRequired)

Sets the value of CfnMethodMixinProps.getApiKeyRequired()

Parameters:

apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

Returns:

this

authorizationScopes

@Stability(Stable)
public CfnMethodMixinProps.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of CfnMethodMixinProps.getAuthorizationScopes()

Parameters:

authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:

this

authorizationType

@Stability(Stable)
public CfnMethodMixinProps.Builder authorizationType(String authorizationType)

Sets the value of CfnMethodMixinProps.getAuthorizationType()

Parameters:

authorizationType - The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference .

If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.

Returns:

this

authorizerId

@Stability(Stable)
public CfnMethodMixinProps.Builder authorizerId(String authorizerId)

Sets the value of CfnMethodMixinProps.getAuthorizerId()

Parameters:

authorizerId - The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .

Returns:

this

authorizerId

@Stability(Stable)
public CfnMethodMixinProps.Builder authorizerId(IAuthorizerRef authorizerId)

Sets the value of CfnMethodMixinProps.getAuthorizerId()

Parameters:

authorizerId - The identifier of an authorizer to use on this method. The method's authorization type must be CUSTOM or COGNITO_USER_POOLS .

Returns:

this

httpMethod

@Stability(Stable)
public CfnMethodMixinProps.Builder httpMethod(String httpMethod)

Sets the value of CfnMethodMixinProps.getHttpMethod()

Parameters:

httpMethod - The method's HTTP verb.

Returns:

this

integration

@Stability(Stable)
public CfnMethodMixinProps.Builder integration(IResolvable integration)

Sets the value of CfnMethodMixinProps.getIntegration()

Parameters:

integration - Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

Returns:

this

integration

@Stability(Stable)
public CfnMethodMixinProps.Builder integration(CfnMethodPropsMixin.IntegrationProperty integration)

Sets the value of CfnMethodMixinProps.getIntegration()

Parameters:

integration - Represents an HTTP , HTTP_PROXY , AWS , AWS_PROXY , or Mock integration.

Returns:

this

methodResponses

@Stability(Stable)
public CfnMethodMixinProps.Builder methodResponses(IResolvable methodResponses)

Sets the value of CfnMethodMixinProps.getMethodResponses()

Parameters:

methodResponses - Gets a method response associated with a given HTTP status code.

Returns:

this

methodResponses

@Stability(Stable)
public CfnMethodMixinProps.Builder methodResponses(List<? extends Object> methodResponses)

Sets the value of CfnMethodMixinProps.getMethodResponses()

Parameters:

methodResponses - Gets a method response associated with a given HTTP status code.

Returns:

this

operationName

@Stability(Stable)
public CfnMethodMixinProps.Builder operationName(String operationName)

Sets the value of CfnMethodMixinProps.getOperationName()

Parameters:

operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Returns:

this

requestModels

@Stability(Stable)
public CfnMethodMixinProps.Builder requestModels(Map<String,String> requestModels)

Sets the value of CfnMethodMixinProps.getRequestModels()

Parameters:

requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Returns:

this

requestModels

@Stability(Stable)
public CfnMethodMixinProps.Builder requestModels(IResolvable requestModels)

Sets the value of CfnMethodMixinProps.getRequestModels()

Parameters:

requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Returns:

this

requestParameters

@Stability(Stable)
public CfnMethodMixinProps.Builder requestParameters(IResolvable requestParameters)

Sets the value of CfnMethodMixinProps.getRequestParameters()

Parameters:

requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Returns:

this

requestParameters

@Stability(Stable)
public CfnMethodMixinProps.Builder requestParameters(Map<String,? extends Object> requestParameters)

Sets the value of CfnMethodMixinProps.getRequestParameters()

Parameters:

requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true ) or optional ( false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

Returns:

this

requestValidatorId

@Stability(Stable)
public CfnMethodMixinProps.Builder requestValidatorId(String requestValidatorId)

Sets the value of CfnMethodMixinProps.getRequestValidatorId()

Parameters:

requestValidatorId - The identifier of a RequestValidator for request validation.

Returns:

this

requestValidatorId

@Stability(Stable)
public CfnMethodMixinProps.Builder requestValidatorId(IRequestValidatorRef requestValidatorId)

Sets the value of CfnMethodMixinProps.getRequestValidatorId()

Parameters:

requestValidatorId - The identifier of a RequestValidator for request validation.

Returns:

this

resourceId

@Stability(Stable)
public CfnMethodMixinProps.Builder resourceId(String resourceId)

Sets the value of CfnMethodMixinProps.getResourceId()

Parameters:

resourceId - The Resource identifier for the MethodResponse resource.

Returns:

this

resourceId

@Stability(Stable)
public CfnMethodMixinProps.Builder resourceId(IResourceRef resourceId)

Sets the value of CfnMethodMixinProps.getResourceId()

Parameters:

resourceId - The Resource identifier for the MethodResponse resource.

Returns:

this

restApiId

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

Sets the value of CfnMethodMixinProps.getRestApiId()

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

this

restApiId

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

Sets the value of CfnMethodMixinProps.getRestApiId()

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

this

build

@Stability(Stable)
public CfnMethodMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnMethodMixinProps

Throws:

NullPointerException - if any required attribute was not provided