Skip to content

Commit 7bfa48c

Browse files
author
Dinesh Sajwan
committed
feat(documentation): updated construct name
1 parent 6697571 commit 7bfa48c

File tree

5 files changed

+46
-46
lines changed

5 files changed

+46
-46
lines changed

apidocs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
### Classes
1414

1515
- [ContainerImage](classes/ContainerImage.md)
16-
- [ContentGenerationAppsyncLambda](classes/ContentGenerationAppsyncLambda.md)
16+
- [ContentGenerationAppSyncLambda](classes/ContentGenerationAppSyncLambda.md)
1717
- [CustomSageMakerEndpoint](classes/CustomSageMakerEndpoint.md)
1818
- [DeepLearningContainerImage](classes/DeepLearningContainerImage.md)
1919
- [HuggingFaceSageMakerEndpoint](classes/HuggingFaceSageMakerEndpoint.md)
@@ -31,7 +31,7 @@
3131

3232
- [AdapterProps](interfaces/AdapterProps.md)
3333
- [ContainerImageConfig](interfaces/ContainerImageConfig.md)
34-
- [ContentGenerationAppsyncLambdaProps](interfaces/ContentGenerationAppsyncLambdaProps.md)
34+
- [ContentGenerationAppSyncLambdaProps](interfaces/ContentGenerationAppSyncLambdaProps.md)
3535
- [CustomSageMakerEndpointProps](interfaces/CustomSageMakerEndpointProps.md)
3636
- [HuggingFaceSageMakerEndpointProps](interfaces/HuggingFaceSageMakerEndpointProps.md)
3737
- [IInstanceAliase](interfaces/IInstanceAliase.md)

apidocs/classes/ContentGenerationAppsyncLambda.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
1-
[@cdklabs/generative-ai-cdk-constructs](../README.md) / ContentGenerationAppsyncLambda
1+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / ContentGenerationAppSyncLambda
22

3-
# Class: ContentGenerationAppsyncLambda
3+
# Class: ContentGenerationAppSyncLambda
44

55
**`Summary`**
66

7-
The ContentGenerationAppsyncLambda class.
7+
The ContentGenerationAppSyncLambda class.
88

99
## Hierarchy
1010

1111
- `Construct`
1212

13-
**`ContentGenerationAppsyncLambda`**
13+
**`ContentGenerationAppSyncLambda`**
1414

1515
## Table of contents
1616

1717
### Constructors
1818

19-
- [constructor](ContentGenerationAppsyncLambda.md#constructor)
19+
- [constructor](ContentGenerationAppSyncLambda.md#constructor)
2020

2121
### Properties
2222

23-
- [generatedImageBus](ContentGenerationAppsyncLambda.md#generatedimagebus)
24-
- [graphqlApi](ContentGenerationAppsyncLambda.md#graphqlapi)
25-
- [node](ContentGenerationAppsyncLambda.md#node)
26-
- [s3GenerateAssetsBucket](ContentGenerationAppsyncLambda.md#s3generateassetsbucket)
27-
- [s3GenerateAssetsBucketInterface](ContentGenerationAppsyncLambda.md#s3generateassetsbucketinterface)
28-
- [securityGroup](ContentGenerationAppsyncLambda.md#securitygroup)
29-
- [vpc](ContentGenerationAppsyncLambda.md#vpc)
23+
- [generatedImageBus](ContentGenerationAppSyncLambda.md#generatedimagebus)
24+
- [graphqlApi](ContentGenerationAppSyncLambda.md#graphqlapi)
25+
- [node](ContentGenerationAppSyncLambda.md#node)
26+
- [s3GenerateAssetsBucket](ContentGenerationAppSyncLambda.md#s3generateassetsbucket)
27+
- [s3GenerateAssetsBucketInterface](ContentGenerationAppSyncLambda.md#s3generateassetsbucketinterface)
28+
- [securityGroup](ContentGenerationAppSyncLambda.md#securitygroup)
29+
- [vpc](ContentGenerationAppSyncLambda.md#vpc)
3030

3131
### Methods
3232

33-
- [toString](ContentGenerationAppsyncLambda.md#tostring)
34-
- [isConstruct](ContentGenerationAppsyncLambda.md#isconstruct)
33+
- [toString](ContentGenerationAppSyncLambda.md#tostring)
34+
- [isConstruct](ContentGenerationAppSyncLambda.md#isconstruct)
3535

3636
## Constructors
3737

3838
### constructor
3939

40-
**new ContentGenerationAppsyncLambda**(`scope`, `id`, `props`): [`ContentGenerationAppsyncLambda`](ContentGenerationAppsyncLambda.md)
40+
**new ContentGenerationAppSyncLambda**(`scope`, `id`, `props`): [`ContentGenerationAppSyncLambda`](ContentGenerationAppSyncLambda.md)
4141

4242
#### Parameters
4343

4444
| Name | Type | Description |
4545
| :------ | :------ | :------ |
4646
| `scope` | `Construct` | represents the scope for all the resources. |
4747
| `id` | `string` | this is a a scope-unique id. |
48-
| `props` | [`ContentGenerationAppsyncLambdaProps`](../interfaces/ContentGenerationAppsyncLambdaProps.md) | user provided props for the construct. |
48+
| `props` | [`ContentGenerationAppSyncLambdaProps`](../interfaces/ContentGenerationAppSyncLambdaProps.md) | user provided props for the construct. |
4949

5050
#### Returns
5151

52-
[`ContentGenerationAppsyncLambda`](ContentGenerationAppsyncLambda.md)
52+
[`ContentGenerationAppSyncLambda`](ContentGenerationAppSyncLambda.md)
5353

5454
**`Summary`**
5555

56-
Constructs a new instance of the ContentGenerationAppsyncLambda class.
56+
Constructs a new instance of the ContentGenerationAppSyncLambda class.
5757

5858
**`Since`**
5959

apidocs/interfaces/ContentGenerationAppsyncLambdaProps.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
[@cdklabs/generative-ai-cdk-constructs](../README.md) / ContentGenerationAppsyncLambdaProps
1+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / ContentGenerationAppSyncLambdaProps
22

3-
# Interface: ContentGenerationAppsyncLambdaProps
3+
# Interface: ContentGenerationAppSyncLambdaProps
44

5-
The properties for the ContentGenerationAppsyncLambdaProps class.
5+
The properties for the ContentGenerationAppSyncLambdaProps class.
66

77
## Table of contents
88

99
### Properties
1010

11-
- [cognitoUserPool](ContentGenerationAppsyncLambdaProps.md#cognitouserpool)
12-
- [enableOperationalMetric](ContentGenerationAppsyncLambdaProps.md#enableoperationalmetric)
13-
- [existingBusInterface](ContentGenerationAppsyncLambdaProps.md#existingbusinterface)
14-
- [existingGeneratedAssetsBucketObj](ContentGenerationAppsyncLambdaProps.md#existinggeneratedassetsbucketobj)
15-
- [existingMergedApi](ContentGenerationAppsyncLambdaProps.md#existingmergedapi)
16-
- [existingSecurityGroup](ContentGenerationAppsyncLambdaProps.md#existingsecuritygroup)
17-
- [existingVpc](ContentGenerationAppsyncLambdaProps.md#existingvpc)
18-
- [generatedAssetsBucketProps](ContentGenerationAppsyncLambdaProps.md#generatedassetsbucketprops)
19-
- [lambdaProvisionedConcurrency](ContentGenerationAppsyncLambdaProps.md#lambdaprovisionedconcurrency)
20-
- [observability](ContentGenerationAppsyncLambdaProps.md#observability)
21-
- [stage](ContentGenerationAppsyncLambdaProps.md#stage)
22-
- [vpcProps](ContentGenerationAppsyncLambdaProps.md#vpcprops)
11+
- [cognitoUserPool](ContentGenerationAppSyncLambdaProps.md#cognitouserpool)
12+
- [enableOperationalMetric](ContentGenerationAppSyncLambdaProps.md#enableoperationalmetric)
13+
- [existingBusInterface](ContentGenerationAppSyncLambdaProps.md#existingbusinterface)
14+
- [existingGeneratedAssetsBucketObj](ContentGenerationAppSyncLambdaProps.md#existinggeneratedassetsbucketobj)
15+
- [existingMergedApi](ContentGenerationAppSyncLambdaProps.md#existingmergedapi)
16+
- [existingSecurityGroup](ContentGenerationAppSyncLambdaProps.md#existingsecuritygroup)
17+
- [existingVpc](ContentGenerationAppSyncLambdaProps.md#existingvpc)
18+
- [generatedAssetsBucketProps](ContentGenerationAppSyncLambdaProps.md#generatedassetsbucketprops)
19+
- [lambdaProvisionedConcurrency](ContentGenerationAppSyncLambdaProps.md#lambdaprovisionedconcurrency)
20+
- [observability](ContentGenerationAppSyncLambdaProps.md#observability)
21+
- [stage](ContentGenerationAppSyncLambdaProps.md#stage)
22+
- [vpcProps](ContentGenerationAppSyncLambdaProps.md#vpcprops)
2323

2424
## Properties
2525

src/patterns/gen-ai/aws-contentgen-appsync-lambda/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ const cognitoPoolId = 'us-east-1_XXXXX';
7474
const userPoolLoaded = cognito.UserPool.fromUserPoolId(this, 'myuserpool', cognitoPoolId);
7575

7676

77-
const imageGeneration = new emergingTech.ContentGenerationAppsyncLambda(this, 'ContentGenerationAppsyncLambda', {
77+
const imageGeneration = new emergingTech.ContentGenerationAppSyncLambda(this, 'ContentGenerationAppSyncLambda', {
7878
cognitoUserPool: userPoolLoaded,
7979

8080
});
@@ -103,7 +103,7 @@ class SampleAppStack(Stack):
103103
cognitoPoolId='us-east-1_XXXXX'
104104
userPool = cognito.UserPool.from_user_pool_id(self, 'myuserpool', cognitoPoolId)
105105

106-
img_generated=genai.ContentGenerationAppsyncLambda(self, "ContentGenerationAppsyncLambda",
106+
img_generated=genai.ContentGenerationAppSyncLambda(self, "ContentGenerationAppSyncLambda",
107107
cognito_user_pool: userPool
108108
)
109109

@@ -223,14 +223,14 @@ Where:
223223
## Initializer
224224

225225
```
226-
new ContentGenerationAppsyncLambda(scope: Construct, id: string, props: ContentGenerationAppsyncLambdaProps)
226+
new ContentGenerationAppSyncLambda(scope: Construct, id: string, props: ContentGenerationAppSyncLambdaProps)
227227
```
228228

229229
Parameters
230230

231231
- scope [Construct](https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Construct.html)
232232
- id string
233-
- props ContentGenerationAppsyncLambdaProps
233+
- props ContentGenerationAppSyncLambdaProps
234234

235235
## Pattern Construct Props
236236

src/patterns/gen-ai/aws-contentgen-appsync-lambda/index.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ import { version } from '../../../common/helpers/utils';
2828
import * as vpc_helper from '../../../common/helpers/vpc-helper';
2929

3030
/**
31-
* The properties for the ContentGenerationAppsyncLambdaProps class.
31+
* The properties for the ContentGenerationAppSyncLambdaProps class.
3232
*/
33-
export interface ContentGenerationAppsyncLambdaProps {
33+
export interface ContentGenerationAppSyncLambdaProps {
3434
/**
3535
* Optional custom properties for a VPC the construct will create. This VPC will
3636
* be used by the Lambda functions the construct creates. Providing
@@ -118,9 +118,9 @@ export interface ContentGenerationAppsyncLambdaProps {
118118
}
119119

120120
/**
121-
* @summary The ContentGenerationAppsyncLambda class.
121+
* @summary The ContentGenerationAppSyncLambda class.
122122
*/
123-
export class ContentGenerationAppsyncLambda extends Construct {
123+
export class ContentGenerationAppSyncLambda extends Construct {
124124
/**
125125
* Returns the instance of ec2.IVpc used by the construct
126126
*/
@@ -149,14 +149,14 @@ export class ContentGenerationAppsyncLambda extends Construct {
149149
public readonly graphqlApi: appsync.IGraphqlApi;
150150

151151
/**
152-
* @summary Constructs a new instance of the ContentGenerationAppsyncLambda class.
152+
* @summary Constructs a new instance of the ContentGenerationAppSyncLambda class.
153153
* @param {cdk.App} scope - represents the scope for all the resources.
154154
* @param {string} id - this is a a scope-unique id.
155-
* @param {ContentGenerationAppsyncLambdaProps} props - user provided props for the construct.
155+
* @param {ContentGenerationAppSyncLambdaProps} props - user provided props for the construct.
156156
* @since 0.0.0
157157
* @access public
158158
*/
159-
constructor(scope: Construct, id: string, props: ContentGenerationAppsyncLambdaProps) {
159+
constructor(scope: Construct, id: string, props: ContentGenerationAppSyncLambdaProps) {
160160
super(scope, id);
161161

162162
// stage

0 commit comments

Comments
 (0)