json.schema.security.credentials.awsCredentials.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/security/credentials/awsCredentials.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "AWSCredentials",
  "description": "AWS credentials configs.",
  "type": "object",
  "javaType": "org.openmetadata.schema.security.credentials.AWSCredentials",
  "properties": {
    "awsAccessKeyId": {
      "title": "AWS Access Key ID",
      "description": "AWS Access key ID.",
      "type": "string"
    },
    "awsSecretAccessKey": {
      "title": "AWS Secret Access Key",
      "description": "AWS Secret Access Key.",
      "type": "string",
      "format": "password"
    },
    "awsRegion": {
      "title": "AWS Region",
      "description": "AWS Region",
      "type": "string"
    },
    "awsSessionToken": {
      "title": "AWS Session Token",
      "description": "AWS Session Token.",
      "type": "string"
    },
    "endPointURL": {
      "title": "Endpoint URL",
      "description": "EndPoint URL for the AWS",
      "type": "string",
      "format": "uri"
    },
    "profileName": {
      "title": "Profile Name",
      "description": "The name of a profile to use with the boto session.",
      "type": "string"
    },
    "assumeRoleArn": {
      "title": "Role Arn for Assume Role",
      "description": "The Amazon Resource Name (ARN) of the role to assume. Required Field in case of Assume Role",
      "type": "string"
    },
    "assumeRoleSessionName": {
      "title": "Role Session Name for Assume Role",
      "description": "An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. Required Field in case of Assume Role",
      "type": "string",
      "default": "OpenMetadataSession"
    },
    "assumeRoleSourceIdentity": {
      "title": "Source Identity for Assume Role",
      "description": "The Amazon Resource Name (ARN) of the role to assume. Optional Field in case of Assume Role",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": ["awsRegion"]
}