CfnDataSourceMixinProps

class aws_cdk.mixins_preview.aws_appsync.mixins.CfnDataSourceMixinProps(*, api_id=None, description=None, dynamo_db_config=None, elasticsearch_config=None, event_bridge_config=None, http_config=None, lambda_config=None, metrics_config=None, name=None, open_search_service_config=None, relational_database_config=None, service_role_arn=None, type=None)

Bases: object

Properties for CfnDataSourcePropsMixin.

Parameters:

  • api_id (Optional[str]) – Unique AWS AppSync GraphQL API identifier where this data source will be created.

  • description (Optional[str]) – The description of the data source.

  • dynamo_db_config (Union[IResolvable, DynamoDBConfigProperty, Dict[str, Any], None]) – AWS Region and TableName for an Amazon DynamoDB table in your account.

  • elasticsearch_config (Union[IResolvable, ElasticsearchConfigProperty, Dict[str, Any], None])

  • event_bridge_config (Union[IResolvable, EventBridgeConfigProperty, Dict[str, Any], None]) – An EventBridge configuration that contains a valid ARN of an event bus.

  • http_config (Union[IResolvable, HttpConfigProperty, Dict[str, Any], None]) – Endpoints for an HTTP data source.

  • lambda_config (Union[IResolvable, LambdaConfigProperty, Dict[str, Any], None]) – An ARN of a Lambda function in valid ARN format. This can be the ARN of a Lambda function that exists in the current account or in another account.

  • metrics_config (Optional[str]) – 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 (Optional[str]) – Friendly name for you to identify your AppSync data source after creation.

  • open_search_service_config (Union[IResolvable, OpenSearchServiceConfigProperty, Dict[str, Any], None]) – AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

  • relational_database_config (Union[IResolvable, RelationalDatabaseConfigProperty, Dict[str, Any], None]) – Relational Database configuration of the relational database data source.

  • service_role_arn (Optional[str]) – The AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source. Required if Type is specified as AWS_LAMBDA , AMAZON_DYNAMODB , AMAZON_ELASTICSEARCH , AMAZON_EVENTBRIDGE , AMAZON_OPENSEARCH_SERVICE , RELATIONAL_DATABASE , or AMAZON_BEDROCK_RUNTIME .

  • type (Optional[str]) – The type of the data source. - AWS_LAMBDA : The data source is an AWS Lambda function. - AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table. - AMAZON_ELASTICSEARCH : The data source is an Amazon OpenSearch Service domain. - AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus. - AMAZON_OPENSEARCH_SERVICE : The data source is an Amazon OpenSearch Service domain. - AMAZON_BEDROCK_RUNTIME : The data source is the Amazon Bedrock runtime. - NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. - HTTP : The data source is an HTTP endpoint. - RELATIONAL_DATABASE : The data source is a relational database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appsync import mixins as appsync_mixins

cfn_data_source_mixin_props = appsync_mixins.CfnDataSourceMixinProps(
    api_id="apiId",
    description="description",
    dynamo_db_config=appsync_mixins.CfnDataSourcePropsMixin.DynamoDBConfigProperty(
        aws_region="awsRegion",
        delta_sync_config=appsync_mixins.CfnDataSourcePropsMixin.DeltaSyncConfigProperty(
            base_table_ttl="baseTableTtl",
            delta_sync_table_name="deltaSyncTableName",
            delta_sync_table_ttl="deltaSyncTableTtl"
        ),
        table_name="tableName",
        use_caller_credentials=False,
        versioned=False
    ),
    elasticsearch_config=appsync_mixins.CfnDataSourcePropsMixin.ElasticsearchConfigProperty(
        aws_region="awsRegion",
        endpoint="endpoint"
    ),
    event_bridge_config=appsync_mixins.CfnDataSourcePropsMixin.EventBridgeConfigProperty(
        event_bus_arn="eventBusArn"
    ),
    http_config=appsync_mixins.CfnDataSourcePropsMixin.HttpConfigProperty(
        authorization_config=appsync_mixins.CfnDataSourcePropsMixin.AuthorizationConfigProperty(
            authorization_type="authorizationType",
            aws_iam_config=appsync_mixins.CfnDataSourcePropsMixin.AwsIamConfigProperty(
                signing_region="signingRegion",
                signing_service_name="signingServiceName"
            )
        ),
        endpoint="endpoint"
    ),
    lambda_config=appsync_mixins.CfnDataSourcePropsMixin.LambdaConfigProperty(
        lambda_function_arn="lambdaFunctionArn"
    ),
    metrics_config="metricsConfig",
    name="name",
    open_search_service_config=appsync_mixins.CfnDataSourcePropsMixin.OpenSearchServiceConfigProperty(
        aws_region="awsRegion",
        endpoint="endpoint"
    ),
    relational_database_config=appsync_mixins.CfnDataSourcePropsMixin.RelationalDatabaseConfigProperty(
        rds_http_endpoint_config=appsync_mixins.CfnDataSourcePropsMixin.RdsHttpEndpointConfigProperty(
            aws_region="awsRegion",
            aws_secret_store_arn="awsSecretStoreArn",
            database_name="databaseName",
            db_cluster_identifier="dbClusterIdentifier",
            schema="schema"
        ),
        relational_database_source_type="relationalDatabaseSourceType"
    ),
    service_role_arn="serviceRoleArn",
    type="type"
)

Attributes

api_id

Unique AWS AppSync GraphQL API identifier where this data source will be created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-apiid

description

The description of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-description

dynamo_db_config

AWS Region and TableName for an Amazon DynamoDB table in your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-dynamodbconfig

elasticsearch_config

this property has been deprecated

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-elasticsearchconfig

Stability:

deprecated

Type:

deprecated

event_bridge_config

An EventBridge configuration that contains a valid ARN of an event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-eventbridgeconfig

http_config

Endpoints for an HTTP data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-httpconfig

lambda_config

An ARN of a Lambda function in valid ARN format.

This can be the ARN of a Lambda function that exists in the current account or in another account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-lambdaconfig

metrics_config

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-metricsconfig

name

Friendly name for you to identify your AppSync data source after creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-name

open_search_service_config

AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-opensearchserviceconfig

relational_database_config

Relational Database configuration of the relational database data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-relationaldatabaseconfig

service_role_arn

The AWS Identity and Access Management service role ARN for the data source.

The system assumes this role when accessing the data source.

Required if Type is specified as AWS_LAMBDA , AMAZON_DYNAMODB , AMAZON_ELASTICSEARCH , AMAZON_EVENTBRIDGE , AMAZON_OPENSEARCH_SERVICE , RELATIONAL_DATABASE , or AMAZON_BEDROCK_RUNTIME .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-servicerolearn

type

The type of the data source.

  • AWS_LAMBDA : The data source is an AWS Lambda function.

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

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

  • AMAZON_EVENTBRIDGE : The data source is an Amazon EventBridge event bus.

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

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

  • NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.

  • HTTP : The data source is an HTTP endpoint.

  • RELATIONAL_DATABASE : The data source is a relational database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html#cfn-appsync-datasource-type