Snowflake · Schema

AwsCredentials

Specifies the AWS credentials of the stage.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
aws_key_id string Scoped credentials generated by AWS Security Token Service (STS).
aws_secret_key string Scoped credentials generated by AWS Security Token Service (STS).
aws_token string Scoped credentials generated by AWS Security Token Service (STS).
aws_role string Omit the security credentials and access keys and, instead, identify the role using AWS_ROLE and specify the AWS role ARN (Amazon Resource Name).
View JSON Schema on GitHub

JSON Schema

snowflake-awscredentials-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AwsCredentials",
  "title": "AwsCredentials",
  "description": "Specifies the AWS credentials of the stage.",
  "allOf": [
    {
      "$ref": "#/components/schemas/Credentials"
    }
  ],
  "properties": {
    "aws_key_id": {
      "type": "string",
      "format": "password",
      "description": "Scoped credentials generated by AWS Security Token Service (STS).",
      "example": "500123"
    },
    "aws_secret_key": {
      "type": "string",
      "format": "password",
      "description": "Scoped credentials generated by AWS Security Token Service (STS).",
      "example": "example_value"
    },
    "aws_token": {
      "type": "string",
      "format": "password",
      "description": "Scoped credentials generated by AWS Security Token Service (STS).",
      "example": "example_value"
    },
    "aws_role": {
      "type": "string",
      "description": "Omit the security credentials and access keys and, instead, identify the role using AWS_ROLE and specify the AWS role ARN (Amazon Resource Name).",
      "example": "example_value"
    }
  }
}