json.schema.entity.services.connections.dashboard.quickSightConnection.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/entity/services/connections/dashboard/quickSightConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "QuickSightConnection",
  "description": "QuickSight Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.dashboard.QuickSightConnection",
  "definitions": {
    "quickSightType": {
      "description": "QuickSight service type",
      "type": "string",
      "enum": [
        "QuickSight"
      ],
      "default": "QuickSight"
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/quickSightType",
      "default": "QuickSight"
    },
    "awsConfig": {
      "title": "AWS Credentials Configuration",
      "$ref": "../../../../security/credentials/awsCredentials.json"
    },
    "awsAccountId": {
      "title": "AWS Account ID",
      "description": "AWS Account ID",
      "type": "string"
    },
    "identityType": {
      "title": "Identity Type",
      "description": "The authentication method that the user uses to sign in.",
      "type": "string",
      "enum": [
        "IAM",
        "QUICKSIGHT",
        "ANONYMOUS"
      ],
      "default": "IAM"
    },
    "namespace": {
      "description": "The Amazon QuickSight namespace that contains the dashboard IDs in this request ( To be provided when identityType is `ANONYMOUS` )",
      "type": "string"
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": [
    "awsConfig",
    "awsAccountId"
  ]
}