software.amazon.awscdk.services.apigateway

Class CfnMethodProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnMethodProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMethodProps>

Enclosing interface:

CfnMethodProps

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

A builder for CfnMethodProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

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

httpMethod

@Stability(value=Stable)
public CfnMethodProps.Builder httpMethod(String httpMethod)

Sets the value of CfnMethodProps.getHttpMethod()

Parameters:

httpMethod - The HTTP method that clients use to call this method. This parameter is required.

Returns:

this

resourceId

@Stability(value=Stable)
public CfnMethodProps.Builder resourceId(String resourceId)

Sets the value of CfnMethodProps.getResourceId()

Parameters:

resourceId - The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) . For root resource methods, specify the `RestApi` root resource ID, such as `{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }` . This parameter is required.

Returns:

this

restApiId

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

Sets the value of CfnMethodProps.getRestApiId()

Parameters:

restApiId - The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method. This parameter is required.

Returns:

this

apiKeyRequired

@Stability(value=Stable)
public CfnMethodProps.Builder apiKeyRequired(Boolean apiKeyRequired)

Sets the value of CfnMethodProps.getApiKeyRequired()

Parameters:

apiKeyRequired - Indicates whether the method requires clients to submit a valid API key.

Returns:

this

apiKeyRequired

@Stability(value=Stable)
public CfnMethodProps.Builder apiKeyRequired(IResolvable apiKeyRequired)

Sets the value of CfnMethodProps.getApiKeyRequired()

Parameters:

apiKeyRequired - Indicates whether the method requires clients to submit a valid API key.

Returns:

this

authorizationScopes

@Stability(value=Stable)
public CfnMethodProps.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of CfnMethodProps.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 match 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(value=Stable)
public CfnMethodProps.Builder authorizationType(String authorizationType)

Sets the value of CfnMethodProps.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(value=Stable)
public CfnMethodProps.Builder authorizerId(String authorizerId)

Sets the value of CfnMethodProps.getAuthorizerId()

Parameters:

authorizerId - The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property.

Returns:

this

integration

@Stability(value=Stable)
public CfnMethodProps.Builder integration(CfnMethod.IntegrationProperty integration)

Sets the value of CfnMethodProps.getIntegration()

Parameters:

integration - The backend system that the method calls when it receives a request.

Returns:

this

integration

@Stability(value=Stable)
public CfnMethodProps.Builder integration(IResolvable integration)

Sets the value of CfnMethodProps.getIntegration()

Parameters:

integration - The backend system that the method calls when it receives a request.

Returns:

this

methodResponses

@Stability(value=Stable)
public CfnMethodProps.Builder methodResponses(IResolvable methodResponses)

Sets the value of CfnMethodProps.getMethodResponses()

Parameters:

methodResponses - The responses that can be sent to the client who calls the method.

Returns:

this

methodResponses

@Stability(value=Stable)
public CfnMethodProps.Builder methodResponses(List<? extends Object> methodResponses)

Sets the value of CfnMethodProps.getMethodResponses()

Parameters:

methodResponses - The responses that can be sent to the client who calls the method.

Returns:

this

operationName

@Stability(value=Stable)
public CfnMethodProps.Builder operationName(String operationName)

Sets the value of CfnMethodProps.getOperationName()

Parameters:

operationName - A friendly operation name for the method. For example, you can assign the OperationName of ListPets for the GET /pets method.

Returns:

this

requestModels

@Stability(value=Stable)
public CfnMethodProps.Builder requestModels(IResolvable requestModels)

Sets the value of CfnMethodProps.getRequestModels()

Parameters:

requestModels - The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.

Returns:

this

requestModels

@Stability(value=Stable)
public CfnMethodProps.Builder requestModels(Map<String,String> requestModels)

Sets the value of CfnMethodProps.getRequestModels()

Parameters:

requestModels - The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value. To use the same model regardless of the content type, specify $default as the key.

Returns:

this

requestParameters

@Stability(value=Stable)
public CfnMethodProps.Builder requestParameters(IResolvable requestParameters)

Sets the value of CfnMethodProps.getRequestParameters()

Parameters:

requestParameters - The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.

Returns:

this

requestParameters

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

Sets the value of CfnMethodProps.getRequestParameters()

Parameters:

requestParameters - The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request. *location* . *name* , where the location is querystring, path, or header, and name is a valid, unique parameter name.

Returns:

this

requestValidatorId

@Stability(value=Stable)
public CfnMethodProps.Builder requestValidatorId(String requestValidatorId)

Sets the value of CfnMethodProps.getRequestValidatorId()

Parameters:

requestValidatorId - The ID of the associated request validator.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnMethodProps

Throws:

NullPointerException - if any required attribute was not provided