Skip to content

Commit e56f949

Browse files
author
AWS
committed
AWS AppSync Update: Documented the new OpenSearchServiceDataSourceConfig data type. Added deprecation notes to the ElasticsearchDataSourceConfig data type.
1 parent 8f2bc42 commit e56f949

File tree

2 files changed

+51
-14
lines changed

2 files changed

+51
-14
lines changed

‎.changes/next-release/feature-AWSAppSync-cf3c4e9.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS AppSync",
4+
"contributor": "",
5+
"description": "Documented the new OpenSearchServiceDataSourceConfig data type. Added deprecation notes to the ElasticsearchDataSourceConfig data type."
6+
}

‎services/appsync/src/main/resources/codegen-resources/service-2.json

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@
716716
"members":{
717717
"authenticationType":{
718718
"shape":"AuthenticationType",
719-
"documentation":"<p>The authentication type: API key, Identity and Access Management, OIDC, or Amazon Cognito user pools.</p>"
719+
"documentation":"<p>The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.</p>"
720720
},
721721
"openIDConnectConfig":{
722722
"shape":"OpenIDConnectConfig",
@@ -728,7 +728,7 @@
728728
},
729729
"lambdaAuthorizerConfig":{
730730
"shape":"LambdaAuthorizerConfig",
731-
"documentation":"<p>Configuration for AWS Lambda function authorization.</p>"
731+
"documentation":"<p>Configuration for Amazon Web Services Lambda function authorization.</p>"
732732
}
733733
},
734734
"documentation":"<p>Describes an additional authentication provider.</p>"
@@ -1094,7 +1094,11 @@
10941094
},
10951095
"elasticsearchConfig":{
10961096
"shape":"ElasticsearchDataSourceConfig",
1097-
"documentation":"<p>Amazon Elasticsearch Service settings.</p>"
1097+
"documentation":"<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>"
1098+
},
1099+
"openSearchServiceConfig":{
1100+
"shape":"OpenSearchServiceDataSourceConfig",
1101+
"documentation":"<p>Amazon OpenSearch Service settings.</p>"
10981102
},
10991103
"httpConfig":{
11001104
"shape":"HttpDataSourceConfig",
@@ -1183,7 +1187,7 @@
11831187
},
11841188
"authenticationType":{
11851189
"shape":"AuthenticationType",
1186-
"documentation":"<p>The authentication type: API key, Identity and Access Management, OIDC, or Amazon Cognito user pools.</p>"
1190+
"documentation":"<p>The authentication type: API key, Identity and Access Management, OIDC, Amazon Cognito user pools, or Amazon Web Services Lambda.</p>"
11871191
},
11881192
"userPoolConfig":{
11891193
"shape":"UserPoolConfig",
@@ -1207,7 +1211,7 @@
12071211
},
12081212
"lambdaAuthorizerConfig":{
12091213
"shape":"LambdaAuthorizerConfig",
1210-
"documentation":"<p>Configuration for AWS Lambda function authorization.</p>"
1214+
"documentation":"<p>Configuration for Amazon Web Services Lambda function authorization.</p>"
12111215
}
12121216
}
12131217
},
@@ -1333,7 +1337,7 @@
13331337
},
13341338
"type":{
13351339
"shape":"DataSourceType",
1336-
"documentation":"<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an Amazon Web Services Lambda function.</p> </li> <li> <p> <b>NONE</b>: 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.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> <li> <p> <b>RELATIONAL_DATABASE</b>: The data source is a relational database.</p> </li> </ul>"
1340+
"documentation":"<p>The type of the data source.</p> <ul> <li> <p> <b>AWS_LAMBDA</b>: The data source is an Amazon Web Services Lambda function.</p> </li> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon OpenSearch Service domain.</p> </li> <li> <p> <b>AMAZON_OPENSEARCH_SERVICE</b>: The data source is an Amazon OpenSearch Service domain.</p> </li> <li> <p> <b>NONE</b>: 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.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> <li> <p> <b>RELATIONAL_DATABASE</b>: The data source is a relational database.</p> </li> </ul>"
13371341
},
13381342
"serviceRoleArn":{
13391343
"shape":"String",
@@ -1349,7 +1353,11 @@
13491353
},
13501354
"elasticsearchConfig":{
13511355
"shape":"ElasticsearchDataSourceConfig",
1352-
"documentation":"<p>Amazon Elasticsearch Service settings.</p>"
1356+
"documentation":"<p>Amazon OpenSearch Service settings.</p>"
1357+
},
1358+
"openSearchServiceConfig":{
1359+
"shape":"OpenSearchServiceDataSourceConfig",
1360+
"documentation":"<p>Amazon OpenSearch Service settings.</p>"
13531361
},
13541362
"httpConfig":{
13551363
"shape":"HttpDataSourceConfig",
@@ -1370,7 +1378,8 @@
13701378
"AMAZON_ELASTICSEARCH",
13711379
"NONE",
13721380
"HTTP",
1373-
"RELATIONAL_DATABASE"
1381+
"RELATIONAL_DATABASE",
1382+
"AMAZON_OPENSEARCH_SERVICE"
13741383
]
13751384
},
13761385
"DataSources":{
@@ -1621,7 +1630,7 @@
16211630
"documentation":"<p>The Amazon Web Services Region.</p>"
16221631
}
16231632
},
1624-
"documentation":"<p>Describes an Elasticsearch data source configuration.</p>"
1633+
"documentation":"<p>Describes an OpenSearch data source configuration.</p> <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use <a>OpenSearchServiceDataSourceConfig</a> to specify an OpenSearch data source.</p>"
16251634
},
16261635
"ErrorMessage":{"type":"string"},
16271636
"FieldLogLevel":{
@@ -2000,7 +2009,7 @@
20002009
},
20012010
"lambdaAuthorizerConfig":{
20022011
"shape":"LambdaAuthorizerConfig",
2003-
"documentation":"<p/> <p>Configuration for AWS Lambda function authorization.</p>"
2012+
"documentation":"<p>Configuration for Amazon Web Services Lambda function authorization.</p>"
20042013
}
20052014
},
20062015
"documentation":"<p>Describes a GraphQL API.</p>"
@@ -2043,11 +2052,11 @@
20432052
},
20442053
"authorizerUri":{
20452054
"shape":"String",
2046-
"documentation":"<p>The ARN of the lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (<code>.../v3</code>) or alias ARN. </p> <p> <i>Note</i>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the AWS CLI, run the following:</p> <p> <code>aws lambda add-permission --function-name \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal appsync.amazonaws.com --action lambda:InvokeFunction</code> </p>"
2055+
"documentation":"<p>The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (<code>.../v3</code>) or alias ARN. </p> <p> <i>Note</i>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:</p> <p> <code>aws lambda add-permission --function-name \"arn:aws:lambda:us-east-2:111122223333:function:my-function\" --statement-id \"appsync\" --principal appsync.amazonaws.com --action lambda:InvokeFunction</code> </p>"
20472056
},
20482057
"identityValidationExpression":{
20492058
"shape":"String",
2050-
"documentation":"<p>A regular expression for validation of tokens before the Lambda Function is called.</p>"
2059+
"documentation":"<p>A regular expression for validation of tokens before the Lambda function is called.</p>"
20512060
}
20522061
},
20532062
"documentation":"<p>A <code>LambdaAuthorizerConfig</code> holds configuration on how to authorize AppSync API access when using the <code>AWS_LAMBDA</code> authorizer mode. Be aware that an AppSync API may have only one Lambda authorizer configured at a time.</p>"
@@ -2452,6 +2461,24 @@
24522461
},
24532462
"documentation":"<p>Describes an OpenID Connect configuration.</p>"
24542463
},
2464+
"OpenSearchServiceDataSourceConfig":{
2465+
"type":"structure",
2466+
"required":[
2467+
"endpoint",
2468+
"awsRegion"
2469+
],
2470+
"members":{
2471+
"endpoint":{
2472+
"shape":"String",
2473+
"documentation":"<p>The endpoint.</p>"
2474+
},
2475+
"awsRegion":{
2476+
"shape":"String",
2477+
"documentation":"<p>The Amazon Web Services Region.</p>"
2478+
}
2479+
},
2480+
"documentation":"<p>Describes an OpenSearch data source configuration.</p>"
2481+
},
24552482
"OutputType":{
24562483
"type":"string",
24572484
"enum":[
@@ -2893,7 +2920,11 @@
28932920
},
28942921
"elasticsearchConfig":{
28952922
"shape":"ElasticsearchDataSourceConfig",
2896-
"documentation":"<p>The new Elasticsearch Service configuration.</p>"
2923+
"documentation":"<p>The new OpenSearch configuration.</p> <p>As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use <a>UpdateDataSourceRequest$openSearchServiceConfig</a> to update an OpenSearch data source.</p>"
2924+
},
2925+
"openSearchServiceConfig":{
2926+
"shape":"OpenSearchServiceDataSourceConfig",
2927+
"documentation":"<p>The new OpenSearch configuration.</p>"
28972928
},
28982929
"httpConfig":{
28992930
"shape":"HttpDataSourceConfig",
@@ -3015,7 +3046,7 @@
30153046
},
30163047
"lambdaAuthorizerConfig":{
30173048
"shape":"LambdaAuthorizerConfig",
3018-
"documentation":"<p>Configuration for AWS Lambda function authorization.</p>"
3049+
"documentation":"<p>Configuration for Amazon Web Services Lambda function authorization.</p>"
30193050
}
30203051
}
30213052
},

0 commit comments

Comments
 (0)