CfnDataSourcePropsMixin
- class aws_cdk.mixins_preview.aws_appsync.mixins.CfnDataSourcePropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::AppSync::DataSourceresource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .Resolvers use these data sources to fetch data when clients make GraphQL calls.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-datasource.html
- CloudformationResource:
AWS::AppSync::DataSource
- Mixin:
true
- 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 import mixins from aws_cdk.mixins_preview.aws_appsync import mixins as appsync_mixins cfn_data_source_props_mixin = appsync_mixins.CfnDataSourcePropsMixin(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" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::AppSync::DataSource.- Parameters:
props (
Union[CfnDataSourceMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['apiId', 'description', 'dynamoDbConfig', 'elasticsearchConfig', 'eventBridgeConfig', 'httpConfig', 'lambdaConfig', 'metricsConfig', 'name', 'openSearchServiceConfig', 'relationalDatabaseConfig', 'serviceRoleArn', 'type']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AwsIamConfigProperty
- class CfnDataSourcePropsMixin.AwsIamConfigProperty(*, signing_region=None, signing_service_name=None)
Bases:
objectUse the
AwsIamConfigproperty type to specifyAwsIamConfigfor a AWS AppSync authorizaton.AwsIamConfigis a property of the AWS AppSync DataSource AuthorizationConfig resource.- Parameters:
signing_region (
Optional[str]) – The signing Region for AWS Identity and Access Management authorization.signing_service_name (
Optional[str]) – The signing service name for AWS Identity and Access Management authorization.
- See:
- 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 aws_iam_config_property = appsync_mixins.CfnDataSourcePropsMixin.AwsIamConfigProperty( signing_region="signingRegion", signing_service_name="signingServiceName" )
Attributes
- signing_region
The signing Region for AWS Identity and Access Management authorization.
- signing_service_name
The signing service name for AWS Identity and Access Management authorization.
DeltaSyncConfigProperty
- class CfnDataSourcePropsMixin.DeltaSyncConfigProperty(*, base_table_ttl=None, delta_sync_table_name=None, delta_sync_table_ttl=None)
Bases:
objectDescribes a Delta Sync configuration.
- Parameters:
base_table_ttl (
Optional[str]) – The number of minutes that an Item is stored in the data source.delta_sync_table_name (
Optional[str]) – The Delta Sync table name.delta_sync_table_ttl (
Optional[str]) – The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
- See:
- 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 delta_sync_config_property = appsync_mixins.CfnDataSourcePropsMixin.DeltaSyncConfigProperty( base_table_ttl="baseTableTtl", delta_sync_table_name="deltaSyncTableName", delta_sync_table_ttl="deltaSyncTableTtl" )
Attributes
- base_table_ttl
The number of minutes that an Item is stored in the data source.
- delta_sync_table_name
The Delta Sync table name.
- delta_sync_table_ttl
The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.
DynamoDBConfigProperty
- class CfnDataSourcePropsMixin.DynamoDBConfigProperty(*, aws_region=None, delta_sync_config=None, table_name=None, use_caller_credentials=None, versioned=None)
Bases:
objectThe
DynamoDBConfigproperty type specifies theAwsRegionandTableNamefor an Amazon DynamoDB table in your account for an AWS AppSync data source.DynamoDBConfigis a property of the AWS::AppSync::DataSource property type.- Parameters:
aws_region (
Optional[str]) – The AWS Region.delta_sync_config (
Union[IResolvable,DeltaSyncConfigProperty,Dict[str,Any],None]) – TheDeltaSyncConfigfor a versioned datasource.table_name (
Optional[str]) – The table name.use_caller_credentials (
Union[bool,IResolvable,None]) – Set toTRUEto use AWS Identity and Access Management with this data source.versioned (
Union[bool,IResolvable,None]) – Set to TRUE to use Conflict Detection and Resolution with this data source.
- See:
- 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 dynamo_dBConfig_property = 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 )
Attributes
- aws_region
The AWS Region.
- delta_sync_config
The
DeltaSyncConfigfor a versioned datasource.
- table_name
The table name.
- use_caller_credentials
Set to
TRUEto use AWS Identity and Access Management with this data source.
- versioned
Set to TRUE to use Conflict Detection and Resolution with this data source.
ElasticsearchConfigProperty
- class CfnDataSourcePropsMixin.ElasticsearchConfigProperty(*, aws_region=None, endpoint=None)
Bases:
object- Parameters:
aws_region (
Optional[str]) – The AWS Region.endpoint (
Optional[str]) – The endpoint.
- See:
- 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 elasticsearch_config_property = appsync_mixins.CfnDataSourcePropsMixin.ElasticsearchConfigProperty( aws_region="awsRegion", endpoint="endpoint" )
Attributes
- aws_region
The AWS Region.
EventBridgeConfigProperty
- class CfnDataSourcePropsMixin.EventBridgeConfigProperty(*, event_bus_arn=None)
Bases:
objectThe data source.
This can be an API destination, resource, or AWS service.
- Parameters:
event_bus_arn (
Optional[str]) – The event bus pipeline’s ARN. For more information about event buses, see EventBridge event buses .- See:
- 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 event_bridge_config_property = appsync_mixins.CfnDataSourcePropsMixin.EventBridgeConfigProperty( event_bus_arn="eventBusArn" )
Attributes
- event_bus_arn
The event bus pipeline’s ARN.
For more information about event buses, see EventBridge event buses .
HttpConfigProperty
- class CfnDataSourcePropsMixin.HttpConfigProperty(*, authorization_config=None, endpoint=None)
Bases:
objectUse the
HttpConfigproperty type to specifyHttpConfigfor an AWS AppSync data source.HttpConfigis a property of the AWS::AppSync::DataSource resource.- Parameters:
authorization_config (
Union[IResolvable,AuthorizationConfigProperty,Dict[str,Any],None]) – The authorization configuration.endpoint (
Optional[str]) – The endpoint.
- See:
- 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 http_config_property = 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" )
Attributes
- authorization_config
The authorization configuration.
LambdaConfigProperty
- class CfnDataSourcePropsMixin.LambdaConfigProperty(*, lambda_function_arn=None)
Bases:
objectThe
LambdaConfigproperty type specifies the Lambda function ARN for an AWS AppSync data source.LambdaConfigis a property of the AWS::AppSync::DataSource property type.- Parameters:
lambda_function_arn (
Optional[str]) – The ARN for the Lambda function.- See:
- 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 lambda_config_property = appsync_mixins.CfnDataSourcePropsMixin.LambdaConfigProperty( lambda_function_arn="lambdaFunctionArn" )
Attributes
- lambda_function_arn
The ARN for the Lambda function.
OpenSearchServiceConfigProperty
- class CfnDataSourcePropsMixin.OpenSearchServiceConfigProperty(*, aws_region=None, endpoint=None)
Bases:
objectThe
OpenSearchServiceConfigproperty type specifies theAwsRegionandEndpointsfor an Amazon OpenSearch Service domain in your account for an AWS AppSync data source.OpenSearchServiceConfigis a property of the AWS::AppSync::DataSource property type.- Parameters:
aws_region (
Optional[str]) – The AWS Region.endpoint (
Optional[str]) – The endpoint.
- See:
- 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 open_search_service_config_property = appsync_mixins.CfnDataSourcePropsMixin.OpenSearchServiceConfigProperty( aws_region="awsRegion", endpoint="endpoint" )
Attributes
- aws_region
The AWS Region.
RdsHttpEndpointConfigProperty
- class CfnDataSourcePropsMixin.RdsHttpEndpointConfigProperty(*, aws_region=None, aws_secret_store_arn=None, database_name=None, db_cluster_identifier=None, schema=None)
Bases:
objectUse the
RdsHttpEndpointConfigproperty type to specify theRdsHttpEndpointfor an AWS AppSync relational database.RdsHttpEndpointConfigis a property of the AWS AppSync DataSource RelationalDatabaseConfig resource.- Parameters:
aws_region (
Optional[str]) – AWS Region for RDS HTTP endpoint.aws_secret_store_arn (
Optional[str]) – The ARN for database credentials stored in AWS Secrets Manager .database_name (
Optional[str]) – Logical database name.db_cluster_identifier (
Optional[str]) – Amazon RDS cluster Amazon Resource Name (ARN).schema (
Optional[str]) – Logical schema name.
- See:
- 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 rds_http_endpoint_config_property = appsync_mixins.CfnDataSourcePropsMixin.RdsHttpEndpointConfigProperty( aws_region="awsRegion", aws_secret_store_arn="awsSecretStoreArn", database_name="databaseName", db_cluster_identifier="dbClusterIdentifier", schema="schema" )
Attributes
- aws_region
AWS Region for RDS HTTP endpoint.
- aws_secret_store_arn
The ARN for database credentials stored in AWS Secrets Manager .
- database_name
Logical database name.
- db_cluster_identifier
Amazon RDS cluster Amazon Resource Name (ARN).
RelationalDatabaseConfigProperty
- class CfnDataSourcePropsMixin.RelationalDatabaseConfigProperty(*, rds_http_endpoint_config=None, relational_database_source_type=None)
Bases:
objectUse the
RelationalDatabaseConfigproperty type to specifyRelationalDatabaseConfigfor an AWS AppSync data source.RelationalDatabaseConfigis a property of the AWS::AppSync::DataSource property type.- Parameters:
rds_http_endpoint_config (
Union[IResolvable,RdsHttpEndpointConfigProperty,Dict[str,Any],None]) – Information about the Amazon RDS resource.relational_database_source_type (
Optional[str]) – The type of relational data source.
- See:
- 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 relational_database_config_property = 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" )
Attributes
- rds_http_endpoint_config
Information about the Amazon RDS resource.
- relational_database_source_type
The type of relational data source.