route#

Autogenerated using pop-create-idem

hub.exec.boto3.client.apigatewayv2.create_route hub.exec.boto3.client.apigatewayv2.delete_route hub.exec.boto3.client.apigatewayv2.get_apis hub.exec.boto3.client.apigatewayv2.get_route hub.exec.boto3.client.apigatewayv2.get_routes hub.exec.boto3.client.apigatewayv2.tag_resource hub.exec.boto3.client.apigatewayv2.untag_resource hub.exec.boto3.client.apigatewayv2.update_route

async idem_aws.states.aws.apigatewayv2.route.present(hub, ctx, name: str, api_id: str, route_key: str, resource_id: str = None, api_key_required: bool = None, authorization_scopes: List[str] = None, authorization_type: str = None, authorizer_id: str = None, model_selection_expression: str = None, operation_name: str = None, request_models: Dict[str, str] = None, request_parameters: Dict[str, RouteParameters] = None, route_response_selection_expression: str = None, target: str = None) → Dict[str, Any][source]#

Creates an API Gateway v2 route resource.

Parameters:

  • name (str) – An Idem name of the resource.

  • api_id (str) – The API resource identifier in Amazon Web Services.

  • route_key (str) – The route key for the route.

  • resource_id (str, Optional) – The route resource identifier in Amazon Web Services.

  • api_key_required (bool, Optional) – Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

  • authorization_scopes (List, Optional) – The authorization scopes supported by this route.

  • authorization_type (str, Optional) – 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.

  • authorizer_id (str, Optional) – 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.

  • model_selection_expression (str, Optional) – The model selection expression for the route. Supported only for WebSocket APIs.

  • operation_name (str, Optional) – The operation name for the route.

  • request_models (Dict[str, str], Optional) – The request models for the route. Supported only for WebSocket APIs.

  • request_parameters (Dict[str, Dict[str, Any]], Optional) – The request parameters for the route. Supported only for WebSocket APIs. Defaults to None. * Required (bool, Optional): Whether or not the parameter is required.

  • route_response_selection_expression (str, Optional) – The route response selection expression for the route. Supported only for WebSocket APIs.

  • target (str, Optional) – The target for the route.

Request Syntax:
[idem_test_aws_apigatewayv2_route]:
aws.apigatewayv2.route.present:

  • name: ‘string’

  • api_id: ‘string’

  • route_key: ‘string’

  • api_key_required: True|False

  • authorization_scopes: [‘string’]

  • authorization_type: ‘NONE’|’AWS_IAM’|’CUSTOM’|’JWT’

  • authorizer_id: ‘string’

  • model_selection_expression: ‘string’

  • operation_name: ‘string’

  • request_models: {‘string’: ‘string’}

  • request_parameters: {
    ‘string’: {

    ‘Required’: True|False

    }

    }

  • route_response_selection_expression: ‘string’

  • target: ‘string’

Returns:

Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_route:
  aws.apigatewayv2.route.present:
    - name: value
    - api_id: value
    - route_key: value
    - api_key_required: True|False
    - authorization_scopes: []
    - authorization_type: value
    - authorizer_id: value
    - model_selection_expression: value
    - operation_name: value
    - request_models: {}
    - request_parameters: {}
    - route_response_selection_expression: value
    - target: value
async idem_aws.states.aws.apigatewayv2.route.absent(hub, ctx, name: str, api_id: str = None, resource_id: str = None) → Dict[str, Any][source]#

Deletes an API Gateway v2 route resource.

Parameters:

  • name (str) – An Idem name of the resource.

  • api_id (str, Optional) – The API resource identifier in Amazon Web Services.

  • resource_id (str, Optional) – The Route resource identifier in Amazon Web Services. Idem automatically considers this resource being absent if this field is not specified.

Returns:

Dict[str, Any]

Examples

idem_test_aws_apigatewayv2_route:
  aws.apigatewayv2.route.absent:
    - name: value
    - api_id: value
    - resource_id: value
async idem_aws.states.aws.apigatewayv2.route.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function

Gets the API Gateway v2 route resources for an AWS account.

Returns:

Dict[str, Dict[str, Any]]

Examples

$ idem describe aws.apigatewayv2.route