AppSyncDataSource
Reference doc for the `sst.aws.AppSyncDataSource` component.
The AppSyncDataSource
component is internally used by the AppSync
component to add
data sources to AWS AppSync.
You’ll find this component returned by the addDataSource
method of the AppSync
component.
Constructor
Parameters
-
name
string
-
args
DataSourceArgs
-
opts?
ComponentResourceOptions
Properties
name
Type Output
<
string
>
The name of the data source.
nodes
Type Object
The underlying resources this component creates.
nodes.dataSource
Type DataSource
The Amazon AppSync DataSource.
nodes.function
Type Output
<
Function
>
The Lambda function used by the data source.
nodes.serviceRole
Type Role
The DataSource service’s IAM role.
DataSourceArgs
apiComponentName
Type string
The AppSync component name.
apiId
Type Input
<
string
>
The AppSync GraphQL API ID.
dynamodb?
Type Input
<
string
>
The ARN for the DynamoDB table.
elasticSearch?
Type Input
<
string
>
The ARN for the Elasticsearch domain.
eventBridge?
Type Input
<
string
>
The ARN for the EventBridge event bus.
http?
Type Input
<
string
>
The URL for the HTTP endpoint.
lambda?
Type Input
<
string
|
FunctionArgs
|
“arn:aws:lambda:${string}”
>
The handler for the Lambda function.
You can pass in the full function props.
You can also pass in the function ARN.
name
Type string
The name of the data source.
openSearch?
Type Input
<
string
>
The ARN for the OpenSearch domain.
rds?
Type Input
<
Object
>
Configure the RDS data source.
rds.cluster
Type Input
<
string
>
The ARN for the RDS cluster.
rds.credentials
Type Input
<
string
>
The ARN for the credentials secret store.
transform?
Type Object
Transform how this component creates its underlying resources.
transform.dataSource?
Type DataSourceArgs
|
(
args
:
DataSourceArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the AppSync DataSource resource.
transform.serviceRole?
Type RoleArgs
|
(
args
:
RoleArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the AppSync DataSource service role resource.