Learn Idem

Learn Idem

Powered by Idem Project

aws.apigatewayv2.route

Deletes an API Gateway v2 route resource.

Args:
    name(string): An Idem name of the resource.
    api_id(string): The API resource identifier in Amazon Web Services.
    resource_id(string, 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:

    .. code-block:: sls

        idem_test_aws_apigatewayv2_route:
          aws.apigatewayv2.route.absent:
            - name: value
            - api_id: value
            - resource_id: value
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:

    .. code-block:: bash

        $ idem describe aws.apigatewayv2.route
Creates an API Gateway v2 route resource.

Args:
    name(string): An Idem name of the resource.
    api_id(string): The API resource identifier in Amazon Web Services.
    route_key(string): The route key for the route.
    resource_id(string, 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(string, 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(string, 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(string, optional): The model selection expression for the route. Supported only for WebSocket APIs.
    operation_name(string, 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(string, optional): The route response selection expression for the route. Supported only for WebSocket APIs.
    target(string, 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:

    .. code-block:: sls

        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
Use an un-managed API Gateway v2 route resource as a data-source.

Args:
    name(string): An Idem name of the resource.
    api_id(string): The API resource identifier in Amazon Web Services.
    resource_id(string): The Route resource identifier in Amazon Web Services.

Request syntax:
    [idem_test_aws_apigatewayv2_route]:
      aws.apigatewayv2.route.search:
        - api_id: 'string'
        - resource_id: 'string'

Returns:
    Dict[str, Any]

Examples:

    .. code-block:: sls

        idem_test_aws_apigatewayv2_route:
          aws.apigatewayv2.route.search:
            - api_id: value
            - resource_id: value

Full plugin documentation is available on the Idem documentation site - aws.apigatewayv2.route .

Last updated on 20 Sep 2022
 Edit on GitHub