generator.yaml

sdk_names:
  model_name: api-gateway
operations:
  PutIntegration:
    operation_type:
      - Create
    resource_name: Integration
  PutMethod:
    operation_type:
      - Create
    resource_name: Method
  PutMethodResponse:
    operation_type:
      - Create
    resource_name: ApiMethodResponse
  DeleteMethodResponse:
    operation_type:
      - Delete
    resource_name: ApiMethodResponse
  UpdateMethodResponse:
    operation_type:
      - Update
    resource_name: ApiMethodResponse
  GetMethodResponse:
    operation_type:
      - READ_ONE
    resource_name: ApiMethodResponse
  PutIntegrationResponse:
    operation_type:
      - Create
    resource_name: ApiIntegrationResponse
  DeleteIntegrationResponse:
    operation_type:
      - Delete
    resource_name: ApiIntegrationResponse
  UpdateIntegrationResponse:
    operation_type:
      - Update
    resource_name: ApiIntegrationResponse
  GetIntegrationResponse:
    operation_type:
      - READ_ONE
    resource_name: ApiIntegrationResponse
ignore:
  resource_names:
    # - ApiKey
    # - Authorizer
    - BasePathMapping
    # - Deployment
    - DocumentationPart
    - DocumentationVersion
    - DomainName
    - DomainNameAccessAssociation
    - Model
    - RequestValidator
    # - Resource
    # - RestApi
    # - Stage
    - UsagePlan
    - UsagePlanKey
    # - VpcLink

  field_paths:
    - Resource.ResourceMethods
    - CreateResourceOutput.ResourceMethods
    - GetApiKeyInput.IncludeValue
    - GetApiKeyOutput.Value
    - CreateApiKeyOutput.Value
    - UpdateApiKeyInput.Value
    - UpdateApiKeyOutput.Value
    - CreateApiKeyOutput.StageKeys
    - UpdateApiKeyOutput.StageKeys
    - GetApiKeyOutput.StageKeys
resources:
  VpcLink:
    fields:
      ID:
        is_primary_key: true
      TargetARNs:
        is_immutable: true
    hooks:
      sdk_update_pre_build_request:
        template_path: hooks/vpc_link/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/vpc_link/sdk_update_post_build_request.go.tpl
      sdk_delete_pre_build_request:
        template_path: hooks/vpc_link/sdk_delete_pre_build_request.go.tpl
    renames:
      operations:
        GetVpcLink:
          input_fields:
            VpcLinkId: Id
        UpdateVpcLink:
          input_fields:
            VpcLinkId: Id
        DeleteVpcLink:
          input_fields:
            VpcLinkId: Id
    synced:
      when:
        - path: Status.Status
          in:
            - AVAILABLE
  # A PutRestApi call exists that allows updating an existing API with an input of external API definitions. Support for
  # this will be added based on customer interest.
  RestApi:
    fields:
      ID:
        is_primary_key: true
      EndpointConfiguration.VPCEndpointIDs:
        references:
          resource: VPCEndpoint
          service_name: ec2
          path: Status.VPCEndpointID
      CloneFrom:
        is_immutable: true
      Version:
        is_immutable: true
    renames:
      operations:
        GetRestApi:
          input_fields:
            RestApiId: Id
        UpdateRestApi:
          input_fields:
            RestApiId: Id
        DeleteRestApi:
          input_fields:
            RestApiId: Id
    hooks:
      sdk_update_pre_build_request:
        template_path: hooks/rest_api/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/rest_api/sdk_update_post_build_request.go.tpl
      delta_pre_compare:
        code: customPreCompare(a, b)
    exceptions:
      terminal_codes:
        - BadRequestException
        - ConflictException
        - NotFoundException
        - InvalidParameter
  Resource:
    tags:
      ignore: true
    fields:
      ID:
        is_primary_key: true
      ParentID:
        references:
          resource: Resource
          path: Status.ID
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_immutable: true
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/resource/sdk_update_post_build_request.go.tpl
    renames:
      operations:
        GetResource:
          input_fields:
            ResourceId: Id
        UpdateResource:
          input_fields:
            ResourceId: Id
        DeleteResource:
          input_fields:
            ResourceId: Id
    exceptions:
      terminal_codes:
        - BadRequestException
        - ConflictException
        - NotFoundException
        - InvalidParameter
  Integration:
    fields:
      ResourceID:
        is_primary_key: true
        references:
          resource: Resource
          path: Status.ID
        is_immutable: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      HTTPMethod:
        is_required: true
        is_immutable: true
      Type:
        is_immutable: true
        go_tag: json:"type,omitempty"
      ConnectionID:
        references:
          resource: VPCLink
          path: Status.ID
    tags:
      ignore: true
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/integration/sdk_update_post_build_request.go.tpl
      delta_pre_compare:
        code: customPreCompare(a, b)
    exceptions:
      terminal_codes:
        - BadRequestException
        - ConflictException
        - NotFoundException
        - InvalidParameter
  # Fields AccessLogSettings and ClientCertificateId are not in the Create API. Support for them will be added based on
  # customer interest.
  Stage:
    fields:
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      StageName:
        is_required: true
        is_immutable: true
    synced:
      when:
        - path: Status.CacheClusterStatus
          in:
            - AVAILABLE
            - NOT_AVAILABLE
    hooks:
      sdk_update_pre_build_request:
        template_path: hooks/stage/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/stage/sdk_update_post_build_request.go.tpl
      delta_pre_compare:
        code: customPreCompare(a, b)
    exceptions:
      terminal_codes:
        - BadRequestException
        - ConflictException
        - NotFoundException
        - InvalidParameter
  Method:
    fields:
      ResourceID:
        is_primary_key: true
        references:
          resource: Resource
          path: Status.ID
        is_immutable: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      HTTPMethod:
        is_required: true
        is_immutable: true
      MethodIntegration.Type:
        go_tag: json:"type,omitempty"
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/method/sdk_update_post_build_request.go.tpl
    exceptions:
      terminal_codes:
        - InvalidParameter
    tags:
      ignore: true
  ApiMethodResponse:
    fields:
      ResourceID:
        references:
          resource: Resource
          path: Status.ID
        is_required: true
        is_immutable: true
        is_primary_key: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      HTTPMethod:
        is_required: true
        is_immutable: true
      StatusCode:
        is_required: true
        is_immutable: true
    tags:
      ignore: true
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/api_method_response/sdk_update_post_build_request.go.tpl
    exceptions:
      terminal_codes:
        - BadRequestException
        - InvalidParameter
  ApiIntegrationResponse:
    fields:
      ResourceID:
        is_primary_key: true
        references:
          resource: Resource
          path: Status.ID
        is_immutable: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      HTTPMethod:
        is_required: true
        is_immutable: true
      StatusCode:
        is_required: true
        is_immutable: true
    tags:
      ignore: true
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/integration_response/sdk_update_post_build_request.go.tpl
    exceptions:
      terminal_codes:
        - BadRequestException
        - InvalidParameter
  ApiKey:
    fields:
      ID:
        is_primary_key: true
      Name:
        is_required: true
      StageKeys:
        list_of: StageKey
      Value:
        is_secret: true
    exceptions:
      terminal_codes:
        - BadRequestException
        - InvalidParameter
    renames:
      operations:
        GetApiKey:
          input_fields:
            ApiKey: Id
        UpdateApiKey:
          input_fields:
            ApiKey: Id
        DeleteApiKey:
          input_fields:
            ApiKey: Id
    hooks:
      sdk_update_pre_build_request:
        template_path: hooks/api_key/sdk_update_pre_build_request.go.tpl
      sdk_update_post_build_request:
        template_path: hooks/api_key/sdk_update_post_build_request.go.tpl
      sdk_read_one_post_request:
        template_path: hooks/api_key/sdk_read_one_post_request.go.tpl
      sdk_create_post_request:
        template_path: hooks/api_key/sdk_update_post_request.go.tpl
      sdk_update_post_request:
        template_path: hooks/api_key/sdk_update_post_request.go.tpl
  Deployment:
    fields:
      ID:
        is_primary_key: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
    renames:
      operations:
        GetDeployment:
          input_fields:
            DeploymentId: Id
        UpdateDeployment:
          input_fields:
            DeploymentId: Id
        DeleteDeployment:
          input_fields:
            DeploymentId: Id
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/deployment/sdk_update_post_build_request.go.tpl
    exceptions:
      terminal_codes:
        - BadRequestException
    tags:
      ignore: true
  Authorizer:
    fields:
      ID:
        is_primary_key: true
      RestAPIID:
        references:
          resource: RestAPI
          path: Status.ID
        is_required: true
        is_immutable: true
      Type:
        go_tag: json:"type,omitempty"
    renames:
      operations:
        GetAuthorizer:
          input_fields:
            AuthorizerId: Id
        UpdateAuthorizer:
          input_fields:
            AuthorizerId: Id
        DeleteAuthorizer:
          input_fields:
            AuthorizerId: Id
    hooks:
      sdk_update_post_build_request:
        template_path: hooks/authorizer/sdk_update_post_build_request.go.tpl
    tags:
      ignore: true
    exceptions:
      terminal_codes:
        - BadRequestException
        - InvalidParameter