software.amazon.awscdk.services.apigateway

Class CfnMethod.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMethod>

Enclosing class:

CfnMethod

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

A fluent builder for CfnMethod.

Method Summary

Modifier and Type	Method and Description
CfnMethod.Builder	apiKeyRequired(Boolean apiKeyRequired) Indicates whether the method requires clients to submit a valid API key.
CfnMethod.Builder	apiKeyRequired(IResolvable apiKeyRequired) Indicates whether the method requires clients to submit a valid API key.
CfnMethod.Builder	authorizationScopes(List<String> authorizationScopes) A list of authorization scopes configured on the method.
CfnMethod.Builder	authorizationType(String authorizationType) The method's authorization type.
CfnMethod.Builder	authorizerId(String authorizerId) The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method.
CfnMethod	build()
static CfnMethod.Builder	create(software.constructs.Construct scope, String id)
CfnMethod.Builder	httpMethod(String httpMethod) The HTTP method that clients use to call this method.
CfnMethod.Builder	integration(CfnMethod.IntegrationProperty integration) The backend system that the method calls when it receives a request.
CfnMethod.Builder	integration(IResolvable integration) The backend system that the method calls when it receives a request.
CfnMethod.Builder	methodResponses(IResolvable methodResponses) The responses that can be sent to the client who calls the method.
CfnMethod.Builder	methodResponses(List<? extends Object> methodResponses) The responses that can be sent to the client who calls the method.
CfnMethod.Builder	operationName(String operationName) A friendly operation name for the method.
CfnMethod.Builder	requestModels(IResolvable requestModels) The resources that are used for the request's content type.
CfnMethod.Builder	requestModels(Map<String,String> requestModels) The resources that are used for the request's content type.
CfnMethod.Builder	requestParameters(IResolvable requestParameters) The request parameters that API Gateway accepts.
CfnMethod.Builder	requestParameters(Map<String,? extends Object> requestParameters) The request parameters that API Gateway accepts.
CfnMethod.Builder	requestValidatorId(String requestValidatorId) The ID of the associated request validator.
CfnMethod.Builder	resourceId(String resourceId) The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) .
CfnMethod.Builder	restApiId(String 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.

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 CfnMethod.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 CfnMethod.IntegrationProperty.Builder.

httpMethod

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

The HTTP method that clients use to call this method.

Parameters:

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

Returns:

this

resourceId

@Stability(value=Stable)
public CfnMethod.Builder resourceId(String 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"] }` .

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 CfnMethod.Builder restApiId(String 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.

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 CfnMethod.Builder apiKeyRequired(Boolean apiKeyRequired)

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

Parameters:

apiKeyRequired - Indicates whether the method requires clients to submit a valid API key. This parameter is required.

Returns:

this

apiKeyRequired

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

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

Parameters:

apiKeyRequired - Indicates whether the method requires clients to submit a valid API key. This parameter is required.

Returns:

this

authorizationScopes

@Stability(value=Stable)
public CfnMethod.Builder authorizationScopes(List<String> 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.

Parameters:

authorizationScopes - A list of authorization scopes configured on the method. This parameter is required.

Returns:

this

authorizationType

@Stability(value=Stable)
public CfnMethod.Builder authorizationType(String 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.

Parameters:

authorizationType - The method's authorization type. This parameter is required.

Returns:

this

authorizerId

@Stability(value=Stable)
public CfnMethod.Builder authorizerId(String 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.

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. This parameter is required.

Returns:

this

integration

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

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

Parameters:

integration - The backend system that the method calls when it receives a request. This parameter is required.

Returns:

this

integration

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

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

Parameters:

integration - The backend system that the method calls when it receives a request. This parameter is required.

Returns:

this

methodResponses

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

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

Parameters:

methodResponses - The responses that can be sent to the client who calls the method. This parameter is required.

Returns:

this

methodResponses

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

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

Parameters:

methodResponses - The responses that can be sent to the client who calls the method. This parameter is required.

Returns:

this

operationName

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

A friendly operation name for the method.

For example, you can assign the OperationName of ListPets for the GET /pets method.

Parameters:

operationName - A friendly operation name for the method. This parameter is required.

Returns:

this

requestModels

@Stability(value=Stable)
public CfnMethod.Builder requestModels(IResolvable 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.

Parameters:

requestModels - The resources that are used for the request's content type. This parameter is required.

Returns:

this

requestModels

@Stability(value=Stable)
public CfnMethod.Builder requestModels(Map<String,String> 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.

Parameters:

requestModels - The resources that are used for the request's content type. This parameter is required.

Returns:

this

requestParameters

@Stability(value=Stable)
public CfnMethod.Builder requestParameters(IResolvable 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.

Parameters:

requestParameters - The request parameters that API Gateway accepts. This parameter is required.

Returns:

this

requestParameters

@Stability(value=Stable)
public CfnMethod.Builder requestParameters(Map<String,? extends Object> 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.

Parameters:

requestParameters - The request parameters that API Gateway accepts. This parameter is required.

Returns:

this

requestValidatorId

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

The ID of the associated request validator.

Parameters:

requestValidatorId - The ID of the associated request validator. This parameter is required.

Returns:

this

build

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

Specified by:

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