OpenSearchDataSourceProps¶
-
class
aws_cdk.aws_appsync.
OpenSearchDataSourceProps
(*, api, description=None, name=None, service_role=None, domain)¶ Bases:
aws_cdk.aws_appsync.BackedDataSourceProps
(experimental) Properties for the OpenSearch Data Source.
- Parameters
api (
IGraphqlApi
) – (experimental) The API to attach this data source to.description (
Optional
[str
]) – (experimental) the description of the data source. Default: - Nonename (
Optional
[str
]) – (experimental) The name of the data source. Default: - id of data sourceservice_role (
Optional
[IRole
]) – (experimental) The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new roledomain (
IDomain
) – (experimental) The OpenSearch domain containing the endpoint for the data source.
- Stability
experimental
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync import aws_cdk.aws_iam as iam import aws_cdk.aws_opensearchservice as opensearchservice # domain: opensearchservice.Domain # graphql_api: appsync.GraphqlApi # role: iam.Role open_search_data_source_props = appsync.OpenSearchDataSourceProps( api=graphql_api, domain=domain, # the properties below are optional description="description", name="name", service_role=role )
Attributes
-
api
¶ (experimental) The API to attach this data source to.
- Stability
experimental
- Return type
-
description
¶ (experimental) the description of the data source.
- Default
None
- Stability
experimental
- Return type
Optional
[str
]
-
domain
¶ (experimental) The OpenSearch domain containing the endpoint for the data source.
- Stability
experimental
- Return type
-
name
¶ (experimental) The name of the data source.
- Default
id of data source
- Stability
experimental
- Return type
Optional
[str
]