Skip to content

DataSource

Source code in docs_src/capo_appsync/types/data_source.py
class DataSource(TypedDict, closed=True):
    data_source_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The data source Amazon Resource Name (ARN).</p>"""
    name: NotRequired["capo_appsync.types.resource_name.ResourceName"]
    """<p>The name of the data source.</p>"""
    description: NotRequired["capo_appsync.types.string.String"]
    """<p>The description of the data source.</p>"""
    type: NotRequired["capo_appsync.types.data_source_type.DataSourceType"]
    """<p>The type of the data source.</p> <ul> <li> <p> <b>AWS_LAMBDA</b>: The data source is an Lambda function.</p> </li> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon OpenSearch Service domain.</p> </li> <li> <p> <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is an Amazon OpenSearch Service domain.</p> </li> <li> <p> <b>AMAZON_EVENTBRIDGE</b>: The data source is an Amazon EventBridge configuration.</p> </li> <li> <p> <b>AMAZON_BEDROCK_RUNTIME</b>: The data source is the Amazon Bedrock runtime.</p> </li> <li> <p> <b>NONE</b>: 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.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> <li> <p> <b>RELATIONAL_DATABASE</b>: The data source is a relational database.</p> </li> </ul>"""
    service_role_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>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.</p>"""
    dynamodb_config: NotRequired[
        "capo_appsync.types.dynamodb_data_source_config.DynamodbDataSourceConfig"
    ]
    """<p>DynamoDB settings.</p>"""
    lambda_config: NotRequired[
        "capo_appsync.types.lambda_data_source_config.LambdaDataSourceConfig"
    ]
    """<p>Lambda settings.</p>"""
    elasticsearch_config: NotRequired[
        "capo_appsync.types.elasticsearch_data_source_config.ElasticsearchDataSourceConfig"
    ]
    """<p>Amazon OpenSearch Service settings.</p>"""
    open_search_service_config: NotRequired[
        "capo_appsync.types.open_search_service_data_source_config.OpenSearchServiceDataSourceConfig"
    ]
    """<p>Amazon OpenSearch Service settings.</p>"""
    http_config: NotRequired[
        "capo_appsync.types.http_data_source_config.HttpDataSourceConfig"
    ]
    """<p>HTTP endpoint settings.</p>"""
    relational_database_config: NotRequired[
        "capo_appsync.types.relational_database_data_source_config.RelationalDatabaseDataSourceConfig"
    ]
    """<p>Relational database settings.</p>"""
    event_bridge_config: NotRequired[
        "capo_appsync.types.event_bridge_data_source_config.EventBridgeDataSourceConfig"
    ]
    """<p>Amazon EventBridge settings.</p>"""
    metrics_config: NotRequired[
        "capo_appsync.types.data_source_level_metrics_config.DataSourceLevelMetricsConfig"
    ]
    """<p>Enables or disables enhanced data source metrics for specified data sources. Note that <code>metricsConfig</code> won't be used unless the <code>dataSourceLevelMetricsBehavior</code> value is set to <code>PER_DATA_SOURCE_METRICS</code>. If the <code>dataSourceLevelMetricsBehavior</code> is set to <code>FULL_REQUEST_DATA_SOURCE_METRICS</code> instead, <code>metricsConfig</code> will be ignored. However, you can still set its value.</p> <p> <code>metricsConfig</code> can be <code>ENABLED</code> or <code>DISABLED</code>.</p>"""

data_source_arn instance-attribute

data_source_arn: NotRequired[String]

The data source Amazon Resource Name (ARN).

description instance-attribute

description: NotRequired[String]

The description of the data source.

dynamodb_config instance-attribute

dynamodb_config: NotRequired[DynamodbDataSourceConfig]

DynamoDB settings.

elasticsearch_config instance-attribute

elasticsearch_config: NotRequired[ElasticsearchDataSourceConfig]

Amazon OpenSearch Service settings.

event_bridge_config instance-attribute

event_bridge_config: NotRequired[EventBridgeDataSourceConfig]

Amazon EventBridge settings.

http_config instance-attribute

http_config: NotRequired[HttpDataSourceConfig]

HTTP endpoint settings.

lambda_config instance-attribute

lambda_config: NotRequired[LambdaDataSourceConfig]

Lambda settings.

metrics_config instance-attribute

metrics_config: NotRequired[DataSourceLevelMetricsConfig]

Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

name instance-attribute

name: NotRequired[ResourceName]

The name of the data source.

open_search_service_config instance-attribute

open_search_service_config: NotRequired[OpenSearchServiceDataSourceConfig]

Amazon OpenSearch Service settings.

relational_database_config instance-attribute

relational_database_config: NotRequired[RelationalDatabaseDataSourceConfig]

Relational database settings.

service_role_arn instance-attribute

service_role_arn: NotRequired[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.

type instance-attribute

type: NotRequired[DataSourceType]

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.

  • AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

  • AMAZON_BEDROCK_RUNTIME: The data source is the Amazon Bedrock runtime.

  • 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.