Skip to content

CreateDataSourceRequest

Source code in docs_src/capo_appsync/types/create_data_source_request.py
class CreateDataSourceRequest(TypedDict, closed=True):
    api_id: "capo_appsync.types.string.String"
    """<p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>"""
    name: "capo_appsync.types.resource_name.ResourceName"
    """<p>A user-supplied name for the <code>DataSource</code>.</p>"""
    description: NotRequired["capo_appsync.types.string.String"]
    """<p>A description of the <code>DataSource</code>.</p>"""
    type: "capo_appsync.types.data_source_type.DataSourceType"
    """<p>The type of the <code>DataSource</code>.</p>"""
    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>Amazon 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> <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use <a>CreateDataSourceRequest$openSearchServiceConfig</a> to create an OpenSearch data source.</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>"""

api_id instance-attribute

api_id: String

The API ID for the GraphQL API for the DataSource.

description instance-attribute

description: NotRequired[String]

A description of the DataSource.

dynamodb_config instance-attribute

dynamodb_config: NotRequired[DynamodbDataSourceConfig]

Amazon DynamoDB settings.

elasticsearch_config instance-attribute

elasticsearch_config: NotRequired[ElasticsearchDataSourceConfig]

Amazon OpenSearch Service settings.

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

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

A user-supplied name for the DataSource.

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

The type of the DataSource.