/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace ApiGatewayV2 { namespace Model { class UpdateRouteResult { public: AWS_APIGATEWAYV2_API UpdateRouteResult(); AWS_APIGATEWAYV2_API UpdateRouteResult(const Aws::AmazonWebServiceResult& result); AWS_APIGATEWAYV2_API UpdateRouteResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

Specifies whether a route is managed by API Gateway. If you created an API * using quick create, the $default route is managed by API Gateway. You can't * modify the $default route key.

*/ inline bool GetApiGatewayManaged() const{ return m_apiGatewayManaged; } /** *

Specifies whether a route is managed by API Gateway. If you created an API * using quick create, the $default route is managed by API Gateway. You can't * modify the $default route key.

*/ inline void SetApiGatewayManaged(bool value) { m_apiGatewayManaged = value; } /** *

Specifies whether a route is managed by API Gateway. If you created an API * using quick create, the $default route is managed by API Gateway. You can't * modify the $default route key.

*/ inline UpdateRouteResult& WithApiGatewayManaged(bool value) { SetApiGatewayManaged(value); return *this;} /** *

Specifies whether an API key is required for this route. Supported only for * WebSocket APIs.

*/ inline bool GetApiKeyRequired() const{ return m_apiKeyRequired; } /** *

Specifies whether an API key is required for this route. Supported only for * WebSocket APIs.

*/ inline void SetApiKeyRequired(bool value) { m_apiKeyRequired = value; } /** *

Specifies whether an API key is required for this route. Supported only for * WebSocket APIs.

*/ inline UpdateRouteResult& WithApiKeyRequired(bool value) { SetApiKeyRequired(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetAuthorizationScopes() const{ return m_authorizationScopes; } /** *

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

*/ inline void SetAuthorizationScopes(const Aws::Vector& value) { m_authorizationScopes = value; } /** *

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

*/ inline void SetAuthorizationScopes(Aws::Vector&& value) { m_authorizationScopes = std::move(value); } /** *

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

*/ inline UpdateRouteResult& WithAuthorizationScopes(const Aws::Vector& value) { SetAuthorizationScopes(value); return *this;} /** *

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

*/ inline UpdateRouteResult& WithAuthorizationScopes(Aws::Vector&& value) { SetAuthorizationScopes(std::move(value)); return *this;} /** *

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

*/ inline UpdateRouteResult& AddAuthorizationScopes(const Aws::String& value) { m_authorizationScopes.push_back(value); return *this; } /** *

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

*/ inline UpdateRouteResult& AddAuthorizationScopes(Aws::String&& value) { m_authorizationScopes.push_back(std::move(value)); return *this; } /** *

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

*/ inline UpdateRouteResult& AddAuthorizationScopes(const char* value) { m_authorizationScopes.push_back(value); return *this; } /** *

The authorization type for the route. For WebSocket APIs, valid values are * NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for * using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, * JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda authorizer.

*/ inline const AuthorizationType& GetAuthorizationType() const{ return m_authorizationType; } /** *

The authorization type for the route. For WebSocket APIs, valid values are * NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for * using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, * JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda authorizer.

*/ inline void SetAuthorizationType(const AuthorizationType& value) { m_authorizationType = value; } /** *

The authorization type for the route. For WebSocket APIs, valid values are * NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for * using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, * JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda authorizer.

*/ inline void SetAuthorizationType(AuthorizationType&& value) { m_authorizationType = std::move(value); } /** *

The authorization type for the route. For WebSocket APIs, valid values are * NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for * using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, * JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda authorizer.

*/ inline UpdateRouteResult& WithAuthorizationType(const AuthorizationType& value) { SetAuthorizationType(value); return *this;} /** *

The authorization type for the route. For WebSocket APIs, valid values are * NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for * using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, * JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM * for using a Lambda authorizer.

*/ inline UpdateRouteResult& WithAuthorizationType(AuthorizationType&& value) { SetAuthorizationType(std::move(value)); return *this;} /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline const Aws::String& GetAuthorizerId() const{ return m_authorizerId; } /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline void SetAuthorizerId(const Aws::String& value) { m_authorizerId = value; } /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline void SetAuthorizerId(Aws::String&& value) { m_authorizerId = std::move(value); } /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline void SetAuthorizerId(const char* value) { m_authorizerId.assign(value); } /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline UpdateRouteResult& WithAuthorizerId(const Aws::String& value) { SetAuthorizerId(value); return *this;} /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline UpdateRouteResult& WithAuthorizerId(Aws::String&& value) { SetAuthorizerId(std::move(value)); return *this;} /** *

The identifier of the Authorizer resource to be associated with this route. * The authorizer identifier is generated by API Gateway when you created the * authorizer.

*/ inline UpdateRouteResult& WithAuthorizerId(const char* value) { SetAuthorizerId(value); return *this;} /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline const Aws::String& GetModelSelectionExpression() const{ return m_modelSelectionExpression; } /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline void SetModelSelectionExpression(const Aws::String& value) { m_modelSelectionExpression = value; } /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline void SetModelSelectionExpression(Aws::String&& value) { m_modelSelectionExpression = std::move(value); } /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline void SetModelSelectionExpression(const char* value) { m_modelSelectionExpression.assign(value); } /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline UpdateRouteResult& WithModelSelectionExpression(const Aws::String& value) { SetModelSelectionExpression(value); return *this;} /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline UpdateRouteResult& WithModelSelectionExpression(Aws::String&& value) { SetModelSelectionExpression(std::move(value)); return *this;} /** *

The model selection expression for the route. Supported only for WebSocket * APIs.

*/ inline UpdateRouteResult& WithModelSelectionExpression(const char* value) { SetModelSelectionExpression(value); return *this;} /** *

The operation name for the route.

*/ inline const Aws::String& GetOperationName() const{ return m_operationName; } /** *

The operation name for the route.

*/ inline void SetOperationName(const Aws::String& value) { m_operationName = value; } /** *

The operation name for the route.

*/ inline void SetOperationName(Aws::String&& value) { m_operationName = std::move(value); } /** *

The operation name for the route.

*/ inline void SetOperationName(const char* value) { m_operationName.assign(value); } /** *

The operation name for the route.

*/ inline UpdateRouteResult& WithOperationName(const Aws::String& value) { SetOperationName(value); return *this;} /** *

The operation name for the route.

*/ inline UpdateRouteResult& WithOperationName(Aws::String&& value) { SetOperationName(std::move(value)); return *this;} /** *

The operation name for the route.

*/ inline UpdateRouteResult& WithOperationName(const char* value) { SetOperationName(value); return *this;} /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline const Aws::Map& GetRequestModels() const{ return m_requestModels; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline void SetRequestModels(const Aws::Map& value) { m_requestModels = value; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline void SetRequestModels(Aws::Map&& value) { m_requestModels = std::move(value); } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& WithRequestModels(const Aws::Map& value) { SetRequestModels(value); return *this;} /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& WithRequestModels(Aws::Map&& value) { SetRequestModels(std::move(value)); return *this;} /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(const Aws::String& key, const Aws::String& value) { m_requestModels.emplace(key, value); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(Aws::String&& key, const Aws::String& value) { m_requestModels.emplace(std::move(key), value); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(const Aws::String& key, Aws::String&& value) { m_requestModels.emplace(key, std::move(value)); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(Aws::String&& key, Aws::String&& value) { m_requestModels.emplace(std::move(key), std::move(value)); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(const char* key, Aws::String&& value) { m_requestModels.emplace(key, std::move(value)); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(Aws::String&& key, const char* value) { m_requestModels.emplace(std::move(key), value); return *this; } /** *

The request models for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestModels(const char* key, const char* value) { m_requestModels.emplace(key, value); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline const Aws::Map& GetRequestParameters() const{ return m_requestParameters; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline void SetRequestParameters(const Aws::Map& value) { m_requestParameters = value; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline void SetRequestParameters(Aws::Map&& value) { m_requestParameters = std::move(value); } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& WithRequestParameters(const Aws::Map& value) { SetRequestParameters(value); return *this;} /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& WithRequestParameters(Aws::Map&& value) { SetRequestParameters(std::move(value)); return *this;} /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(const Aws::String& key, const ParameterConstraints& value) { m_requestParameters.emplace(key, value); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(Aws::String&& key, const ParameterConstraints& value) { m_requestParameters.emplace(std::move(key), value); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(const Aws::String& key, ParameterConstraints&& value) { m_requestParameters.emplace(key, std::move(value)); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(Aws::String&& key, ParameterConstraints&& value) { m_requestParameters.emplace(std::move(key), std::move(value)); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(const char* key, ParameterConstraints&& value) { m_requestParameters.emplace(key, std::move(value)); return *this; } /** *

The request parameters for the route. Supported only for WebSocket APIs.

*/ inline UpdateRouteResult& AddRequestParameters(const char* key, const ParameterConstraints& value) { m_requestParameters.emplace(key, value); return *this; } /** *

The route ID.

*/ inline const Aws::String& GetRouteId() const{ return m_routeId; } /** *

The route ID.

*/ inline void SetRouteId(const Aws::String& value) { m_routeId = value; } /** *

The route ID.

*/ inline void SetRouteId(Aws::String&& value) { m_routeId = std::move(value); } /** *

The route ID.

*/ inline void SetRouteId(const char* value) { m_routeId.assign(value); } /** *

The route ID.

*/ inline UpdateRouteResult& WithRouteId(const Aws::String& value) { SetRouteId(value); return *this;} /** *

The route ID.

*/ inline UpdateRouteResult& WithRouteId(Aws::String&& value) { SetRouteId(std::move(value)); return *this;} /** *

The route ID.

*/ inline UpdateRouteResult& WithRouteId(const char* value) { SetRouteId(value); return *this;} /** *

The route key for the route.

*/ inline const Aws::String& GetRouteKey() const{ return m_routeKey; } /** *

The route key for the route.

*/ inline void SetRouteKey(const Aws::String& value) { m_routeKey = value; } /** *

The route key for the route.

*/ inline void SetRouteKey(Aws::String&& value) { m_routeKey = std::move(value); } /** *

The route key for the route.

*/ inline void SetRouteKey(const char* value) { m_routeKey.assign(value); } /** *

The route key for the route.

*/ inline UpdateRouteResult& WithRouteKey(const Aws::String& value) { SetRouteKey(value); return *this;} /** *

The route key for the route.

*/ inline UpdateRouteResult& WithRouteKey(Aws::String&& value) { SetRouteKey(std::move(value)); return *this;} /** *

The route key for the route.

*/ inline UpdateRouteResult& WithRouteKey(const char* value) { SetRouteKey(value); return *this;} /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline const Aws::String& GetRouteResponseSelectionExpression() const{ return m_routeResponseSelectionExpression; } /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline void SetRouteResponseSelectionExpression(const Aws::String& value) { m_routeResponseSelectionExpression = value; } /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline void SetRouteResponseSelectionExpression(Aws::String&& value) { m_routeResponseSelectionExpression = std::move(value); } /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline void SetRouteResponseSelectionExpression(const char* value) { m_routeResponseSelectionExpression.assign(value); } /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline UpdateRouteResult& WithRouteResponseSelectionExpression(const Aws::String& value) { SetRouteResponseSelectionExpression(value); return *this;} /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline UpdateRouteResult& WithRouteResponseSelectionExpression(Aws::String&& value) { SetRouteResponseSelectionExpression(std::move(value)); return *this;} /** *

The route response selection expression for the route. Supported only for * WebSocket APIs.

*/ inline UpdateRouteResult& WithRouteResponseSelectionExpression(const char* value) { SetRouteResponseSelectionExpression(value); return *this;} /** *

The target for the route.

*/ inline const Aws::String& GetTarget() const{ return m_target; } /** *

The target for the route.

*/ inline void SetTarget(const Aws::String& value) { m_target = value; } /** *

The target for the route.

*/ inline void SetTarget(Aws::String&& value) { m_target = std::move(value); } /** *

The target for the route.

*/ inline void SetTarget(const char* value) { m_target.assign(value); } /** *

The target for the route.

*/ inline UpdateRouteResult& WithTarget(const Aws::String& value) { SetTarget(value); return *this;} /** *

The target for the route.

*/ inline UpdateRouteResult& WithTarget(Aws::String&& value) { SetTarget(std::move(value)); return *this;} /** *

The target for the route.

*/ inline UpdateRouteResult& WithTarget(const char* value) { SetTarget(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline UpdateRouteResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline UpdateRouteResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline UpdateRouteResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: bool m_apiGatewayManaged; bool m_apiKeyRequired; Aws::Vector m_authorizationScopes; AuthorizationType m_authorizationType; Aws::String m_authorizerId; Aws::String m_modelSelectionExpression; Aws::String m_operationName; Aws::Map m_requestModels; Aws::Map m_requestParameters; Aws::String m_routeId; Aws::String m_routeKey; Aws::String m_routeResponseSelectionExpression; Aws::String m_target; Aws::String m_requestId; }; } // namespace Model } // namespace ApiGatewayV2 } // namespace Aws