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

export interface DsObjectsArgs {
  /**
   * (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws
   * .amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified
   */
  bucket: string | core.StringOut;

  /**
   * (Optional) A character used to group keys (Default: none)
   */
  delimiter?: string | core.StringOut;

  /**
   * (Optional) Encodes keys using this method (Default: none; besides none, only "url" can be used)
   */
  encodingType?: string | core.StringOut;

  /**
   * (Optional) Boolean specifying whether to populate the owner list (Default: false)
   */
  fetchOwner?: boolean | core.BooleanOut;

  /**
   * (Optional) Maximum object keys to return (Default: 1000)
   */
  maxKeys?: number | core.NumberOut;

  /**
   * (Optional) Limits results to object keys with this prefix (Default: none)
   */
  prefix?: string | core.StringOut;

  /**
   * (Optional) Returns key names lexicographically after a specific object key in your bucket (Default:
   * none; S3 lists object keys in UTF-8 character encoding in lexicographical order)
   */
  startAfter?: string | core.StringOut;
}

export class DsObjects extends core.Data<DsObjectsArgs> {
  /**
   * (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws
   * .amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified
   */
  @core.attr(String)
  public bucket!: string | core.StringOut;

  /**
   * List of any keys between `prefix` and the next occurrence of `delimiter` (i.e., similar to subdirect
   * ories of the `prefix` "directory"); the list is only returned when you specify `delimiter`
   */
  @core.attr(String, { computed: true, kind: "array" })
  public commonPrefixes!: core.Array<string> | core.ArrayOut<core.StringOut>;

  /**
   * (Optional) A character used to group keys (Default: none)
   */
  @core.attr(String)
  public delimiter?: string | core.StringOut;

  /**
   * (Optional) Encodes keys using this method (Default: none; besides none, only "url" can be used)
   */
  @core.attr(String)
  public encodingType?: string | core.StringOut;

  /**
   * (Optional) Boolean specifying whether to populate the owner list (Default: false)
   */
  @core.attr(Boolean)
  public fetchOwner?: boolean | core.BooleanOut;

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

  /**
   * List of strings representing object keys
   */
  @core.attr(String, { computed: true, kind: "array" })
  public keys!: core.Array<string> | core.ArrayOut<core.StringOut>;

  /**
   * (Optional) Maximum object keys to return (Default: 1000)
   */
  @core.attr(Number)
  public maxKeys?: number | core.NumberOut;

  /**
   * List of strings representing object owner IDs (see `fetch_owner` above)
   */
  @core.attr(String, { computed: true, kind: "array" })
  public owners!: core.Array<string> | core.ArrayOut<core.StringOut>;

  /**
   * (Optional) Limits results to object keys with this prefix (Default: none)
   */
  @core.attr(String)
  public prefix?: string | core.StringOut;

  /**
   * (Optional) Returns key names lexicographically after a specific object key in your bucket (Default:
   * none; S3 lists object keys in UTF-8 character encoding in lexicographical order)
   */
  @core.attr(String)
  public startAfter?: string | core.StringOut;

  constructor(name: string, args?: DsObjectsArgs) {
    super(name, "aws_s3_objects", args);
  }

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