import * as core from "@terrascript/core";

export interface BasePathMappingArgs extends core.ResourceArgs {
  /**
   * (Required) The id of the API to connect.
   */
  apiId: string | core.StringOut;

  /**
   * (Optional) Path segment that must be prepended to the path when accessing the API via this mapping.
   * If omitted, the API is exposed at the root of the given domain.
   */
  basePath?: string | core.StringOut;

  /**
   * (Required) The already-registered domain name to connect the API to.
   */
  domainName: string | core.StringOut;

  /**
   * (Optional) The name of a specific deployment stage to expose at the given path. If omitted, callers
   * may select any stage by including its name as a path element after the base path.
   */
  stageName?: string | core.StringOut;
}

export class BasePathMapping extends core.Resource<BasePathMappingArgs> {
  /**
   * (Required) The id of the API to connect.
   */
  @core.attr(String)
  public apiId!: string | core.StringOut;

  /**
   * (Optional) Path segment that must be prepended to the path when accessing the API via this mapping.
   * If omitted, the API is exposed at the root of the given domain.
   */
  @core.attr(String)
  public basePath?: string | core.StringOut;

  /**
   * (Required) The already-registered domain name to connect the API to.
   */
  @core.attr(String)
  public domainName!: string | core.StringOut;

  @core.attr(String, { computed: true })
  public id!: string | core.StringOut;

  /**
   * (Optional) The name of a specific deployment stage to expose at the given path. If omitted, callers
   * may select any stage by including its name as a path element after the base path.
   */
  @core.attr(String)
  public stageName?: string | core.StringOut;

  constructor(name: string, args?: BasePathMappingArgs) {
    super(name, "aws_api_gateway_base_path_mapping", args);
  }

  public override getNamespace(): string {
    return "aws_api_gateway";
  }
}