Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DataSource

Describes a data source.

Index

Properties

Optional dataSourceArn

dataSourceArn: undefined | string

The data source Amazon Resource Name (ARN).

Optional description

description: undefined | string

The description of the data source.

Optional dynamodbConfig

dynamodbConfig: DynamodbDataSourceConfig

DynamoDB settings.

Optional elasticsearchConfig

elasticsearchConfig: ElasticsearchDataSourceConfig

Amazon OpenSearch Service settings.

Optional httpConfig

HTTP endpoint settings.

Optional lambdaConfig

Lambda settings.

Optional name

name: undefined | string

The name of the data source.

Optional openSearchServiceConfig

openSearchServiceConfig: OpenSearchServiceDataSourceConfig

Amazon OpenSearch Service settings.

Optional relationalDatabaseConfig

relationalDatabaseConfig: RelationalDatabaseDataSourceConfig

Relational database settings.

Optional serviceRoleArn

serviceRoleArn: undefined | string

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

Optional type

type: DataSourceType | string

The type of the data source.

  • AWS_LAMBDA: The data source is an Lambda function.

  • AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

  • AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.

  • AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.

  • NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.

  • HTTP: The data source is an HTTP endpoint.

  • RELATIONAL_DATABASE: The data source is a relational database.