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

export interface DsExportArgs {
  /**
   * (Required) The API identifier.
   */
  apiId: string | core.StringOut;

  /**
   * (Optional) The version of the API Gateway export algorithm. API Gateway uses the latest version by d
   * efault. Currently, the only supported version is `1.0`.
   */
  exportVersion?: string | core.StringOut;

  /**
   * (Optional) Specifies whether to include API Gateway extensions in the exported API definition. API G
   * ateway extensions are included by default.
   */
  includeExtensions?: boolean | core.BooleanOut;

  /**
   * (Required) The output type of the exported definition file. Valid values are `JSON` and `YAML`.
   */
  outputType: string | core.StringOut;

  /**
   * (Required) The version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only suppor
   * ted value.
   */
  specification: string | core.StringOut;

  /**
   * (Optional) The name of the API stage to export. If you don't specify this property, a representation
   * of the latest API configuration is exported.
   */
  stageName?: string | core.StringOut;
}

export class DsExport extends core.Data<DsExportArgs> {
  /**
   * (Required) The API identifier.
   */
  @core.attr(String)
  public apiId!: string | core.StringOut;

  /**
   * The id of the API.
   */
  @core.attr(String, { computed: true })
  public body!: string | core.StringOut;

  /**
   * (Optional) The version of the API Gateway export algorithm. API Gateway uses the latest version by d
   * efault. Currently, the only supported version is `1.0`.
   */
  @core.attr(String)
  public exportVersion?: string | core.StringOut;

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

  /**
   * (Optional) Specifies whether to include API Gateway extensions in the exported API definition. API G
   * ateway extensions are included by default.
   */
  @core.attr(Boolean)
  public includeExtensions?: boolean | core.BooleanOut;

  /**
   * (Required) The output type of the exported definition file. Valid values are `JSON` and `YAML`.
   */
  @core.attr(String)
  public outputType!: string | core.StringOut;

  /**
   * (Required) The version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only suppor
   * ted value.
   */
  @core.attr(String)
  public specification!: string | core.StringOut;

  /**
   * (Optional) The name of the API stage to export. If you don't specify this property, a representation
   * of the latest API configuration is exported.
   */
  @core.attr(String)
  public stageName?: string | core.StringOut;

  constructor(name: string, args?: DsExportArgs) {
    super(name, "aws_apigatewayv2_export", args);
  }

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