diff --git a/src/pages/cli/graphql/override.mdx b/src/pages/cli/graphql/override.mdx index d672d88cf15..cfa293b53ce 100644 --- a/src/pages/cli/graphql/override.mdx +++ b/src/pages/cli/graphql/override.mdx @@ -118,6 +118,71 @@ export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { } ``` +### Example - Configure OpenSearch Streaming function name +Override the name of the AWS Lambda searchable streaming function + +```ts +import { AmplifyApiGraphQlResourceStackTemplate } from '@aws-amplify/cli-extensibility-helper'; + +export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { + resources.opensearch.OpenSearchStreamingLambdaFunction.FunctionName = 'CustomFunctionName'; +} + +``` + +### Example - Configure OpenSearch instance version + +Override the `elasticsearchVersion` in the OpenSearch domain created by `@searchable` + +```ts +import { AmplifyApiGraphQlResourceStackTemplate } from '@aws-amplify/cli-extensibility-helper'; + +export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { + resources.opensearch.OpenSearchDomain.elasticsearchVersion = 'OpenSearch_1.3'; +} +``` +### Example - Configure OpenSearch instance type + +Override the type of instance launched into the OpenSearch domain created by `@searchable` + +```ts +import { AmplifyApiGraphQlResourceStackTemplate } from '@aws-amplify/cli-extensibility-helper'; + +export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { + resources.opensearch.OpenSearchDomain.elasticsearchClusterConfig = { + ...resources.opensearch.OpenSearchDomain.elasticsearchClusterConfig, + instanceType: "m3.medium.elasticsearch", + }; +} +``` +### Example - Configure OpenSearch instance count +Override the number of instances launched into the OpenSearch domain created by `@searchable` + +```ts +import { AmplifyApiGraphQlResourceStackTemplate } from '@aws-amplify/cli-extensibility-helper'; + +export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { + resources.opensearch.OpenSearchDomain.elasticsearchClusterConfig = { + ...resources.opensearch.OpenSearchDomain.elasticsearchClusterConfig, + instanceCount : 2 + }; +} +``` + +### Example - Configure OpenSearch EBS volume size +Override the amount of disk space allocated to each instance in the OpenSearch domain created by `@searchable` + +```ts +import { AmplifyApiGraphQlResourceStackTemplate } from '@aws-amplify/cli-extensibility-helper'; + +export function override(resources: AmplifyApiGraphQlResourceStackTemplate) { + resources.opensearch.OpenSearchDomain.ebsOptions={ + ...resources.opensearch.OpenSearchDomain.ebsOptions, + volumeSize:10 + } +} +``` + ## Customize Amplify-generated resources for @predictions directive Apply all the overrides in the `override(...)` function. For example, to add a Path to IAM role that facilitates text translation: @@ -197,4 +262,4 @@ To map the CreatePostResolver and the relational resolvers to a stack named 'MyC "BlogpostsResolver": "MyCustomStack", "PostblogResolver": "MyCustomStack", } -``` \ No newline at end of file +```