Interface PutMethodRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<PutMethodRequest.Builder,
,PutMethodRequest> SdkBuilder<PutMethodRequest.Builder,
,PutMethodRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutMethodRequest
-
Method Summary
Modifier and TypeMethodDescriptionapiKeyRequired
(Boolean apiKeyRequired) Specifies whether the method required a valid ApiKey.authorizationScopes
(String... authorizationScopes) A list of authorization scopes configured on the method.authorizationScopes
(Collection<String> authorizationScopes) A list of authorization scopes configured on the method.authorizationType
(String authorizationType) The method's authorization type.authorizerId
(String authorizerId) Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.httpMethod
(String httpMethod) Specifies the method request's HTTP method type.operationName
(String operationName) A human-friendly operation identifier for the method.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestModels
(Map<String, String> requestModels) Specifies the Model resources used for the request's content type.requestParameters
(Map<String, Boolean> requestParameters) A key-value map defining required or optional method request parameters that can be accepted by API Gateway.requestValidatorId
(String requestValidatorId) The identifier of a RequestValidator for validating the method request.resourceId
(String resourceId) The Resource identifier for the new Method resource.The string identifier of the associated RestApi.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Parameters:
restApiId
- The string identifier of the associated RestApi.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceId
The Resource identifier for the new Method resource.
- Parameters:
resourceId
- The Resource identifier for the new Method resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpMethod
Specifies the method request's HTTP method type.
- Parameters:
httpMethod
- Specifies the method request's HTTP method type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizationType
The method's authorization type. Valid values are
NONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.- Parameters:
authorizationType
- The method's authorization type. Valid values areNONE
for open access,AWS_IAM
for using AWS IAM permissions,CUSTOM
for using a custom authorizer, orCOGNITO_USER_POOLS
for using a Cognito user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizerId
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
- Parameters:
authorizerId
- Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiKeyRequired
Specifies whether the method required a valid ApiKey.
- Parameters:
apiKeyRequired
- Specifies whether the method required a valid ApiKey.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationName
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.- Parameters:
operationName
- A human-friendly operation identifier for the method. For example, you can assign theoperationName
ofListPets
for theGET /pets
method in thePetStore
example.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestParameters
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of
method.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
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 body-mapping templates.- Parameters:
requestParameters
- A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern ofmethod.request.{location}.{name}
, wherelocation
isquerystring
,path
, orheader
andname
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 body-mapping templates.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestModels
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
- Parameters:
requestModels
- Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestValidatorId
The identifier of a RequestValidator for validating the method request.
- Parameters:
requestValidatorId
- The identifier of a RequestValidator for validating the method request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
authorizationScopes
- A list of authorization scopes configured on the method. The scopes are used with aCOGNITO_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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
authorizationScopes
- A list of authorization scopes configured on the method. The scopes are used with aCOGNITO_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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
PutMethodRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PutMethodRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-