@awboost/cfn-resource-types 0.1.20 → 0.1.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,12 +1,14 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource Type definition for AWS::AppSync::Resolver
4
+ * The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).
5
+ When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
6
+ See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html}
6
8
  */
7
9
  export type AppSyncResolverProperties = {
8
10
  /**
9
- * The AWS AppSync GraphQL API to which you want to attach this resolver.
11
+ * The APSYlong GraphQL API to which you want to attach this resolver.
10
12
  */
11
13
  ApiId: string;
12
14
  /**
@@ -14,7 +16,7 @@ export type AppSyncResolverProperties = {
14
16
  */
15
17
  CachingConfig?: CachingConfig;
16
18
  /**
17
- * The resolver code that contains the request and response functions. When code is used, the runtime is required.
19
+ * The ``resolver`` code that contains the request and response functions. When code is used, the ``runtime`` is required. The runtime value must be ``APPSYNC_JS``.
18
20
  */
19
21
  Code?: string;
20
22
  /**
@@ -30,11 +32,13 @@ export type AppSyncResolverProperties = {
30
32
  */
31
33
  FieldName: string;
32
34
  /**
33
- * The resolver type.
34
- */
35
+ * The resolver type.
36
+ + *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
37
+ + *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of ``Function`` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
38
+ */
35
39
  Kind?: string;
36
40
  /**
37
- * The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
41
+ * The maximum number of resolver request inputs that will be sent to a single LAMlong function in a ``BatchInvoke`` operation.
38
42
  */
39
43
  MaxBatchSize?: number;
40
44
  /**
@@ -42,11 +46,12 @@ export type AppSyncResolverProperties = {
42
46
  */
43
47
  PipelineConfig?: PipelineConfig;
44
48
  /**
45
- * Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
46
- */
49
+ * The request mapping template.
50
+ Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
51
+ */
47
52
  RequestMappingTemplate?: string;
48
53
  /**
49
- * The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
54
+ * The location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
50
55
  */
51
56
  RequestMappingTemplateS3Location?: string;
52
57
  /**
@@ -54,15 +59,15 @@ export type AppSyncResolverProperties = {
54
59
  */
55
60
  ResponseMappingTemplate?: string;
56
61
  /**
57
- * The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
62
+ * The location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
58
63
  */
59
64
  ResponseMappingTemplateS3Location?: string;
60
65
  /**
61
- * Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
66
+ * Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
62
67
  */
63
68
  Runtime?: AppSyncRuntime;
64
69
  /**
65
- * The SyncConfig for a resolver attached to a versioned data source.
70
+ * The ``SyncConfig`` for a resolver attached to a versioned data source.
66
71
  */
67
72
  SyncConfig?: SyncConfig;
68
73
  /**
@@ -75,42 +80,43 @@ export type AppSyncResolverProperties = {
75
80
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html#aws-resource-appsync-resolver-return-values}
76
81
  */
77
82
  export type AppSyncResolverAttributes = {
78
- /**
79
- * The Amazon Resource Name (ARN) for the resolver.
80
- */
81
83
  ResolverArn: string;
82
84
  };
83
85
  /**
84
86
  * Type definition for `AWS::AppSync::Resolver.AppSyncRuntime`.
87
+ * Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
85
88
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-appsyncruntime.html}
86
89
  */
87
90
  export type AppSyncRuntime = {
88
91
  /**
89
- * The name of the runtime to use.
92
+ * The ``name`` of the runtime to use. Currently, the only allowed value is ``APPSYNC_JS``.
90
93
  */
91
94
  Name: string;
92
95
  /**
93
- * The version of the runtime to use.
96
+ * The ``version`` of the runtime to use. Currently, the only allowed version is ``1.0.0``.
94
97
  */
95
98
  RuntimeVersion: string;
96
99
  };
97
100
  /**
98
101
  * Type definition for `AWS::AppSync::Resolver.CachingConfig`.
102
+ * The caching configuration for a resolver that has caching activated.
99
103
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-cachingconfig.html}
100
104
  */
101
105
  export type CachingConfig = {
102
106
  /**
103
- * The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
104
- */
107
+ * The caching keys for a resolver that has caching activated.
108
+ Valid values are entries from the ``$context.arguments``, ``$context.source``, and ``$context.identity`` maps.
109
+ */
105
110
  CachingKeys?: string[];
106
111
  /**
107
- * The TTL in seconds for a resolver that has caching activated. Valid values are 1-36.00 seconds.
108
- */
112
+ * The TTL in seconds for a resolver that has caching activated.
113
+ Valid values are 1–3,600 seconds.
114
+ */
109
115
  Ttl: number;
110
116
  };
111
117
  /**
112
118
  * Type definition for `AWS::AppSync::Resolver.LambdaConflictHandlerConfig`.
113
- * The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
119
+ * The ``LambdaConflictHandlerConfig`` when configuring LAMBDA as the Conflict Handler.
114
120
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-lambdaconflicthandlerconfig.html}
115
121
  */
116
122
  export type LambdaConflictHandlerConfig = {
@@ -121,34 +127,45 @@ export type LambdaConflictHandlerConfig = {
121
127
  };
122
128
  /**
123
129
  * Type definition for `AWS::AppSync::Resolver.PipelineConfig`.
130
+ * Use the ``PipelineConfig`` property type to specify ``PipelineConfig`` for an APSYlong resolver.
131
+ ``PipelineConfig`` is a property of the [AWS::AppSync::Resolver](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html) resource.
124
132
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-pipelineconfig.html}
125
133
  */
126
134
  export type PipelineConfig = {
127
135
  /**
128
- * A list of Function objects.
136
+ * A list of ``Function`` objects.
129
137
  */
130
138
  Functions?: string[];
131
139
  };
132
140
  /**
133
141
  * Type definition for `AWS::AppSync::Resolver.SyncConfig`.
142
+ * Describes a Sync configuration for a resolver.
143
+ Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
134
144
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-resolver-syncconfig.html}
135
145
  */
136
146
  export type SyncConfig = {
137
147
  /**
138
- * The Conflict Detection strategy to use.
139
- */
148
+ * The Conflict Detection strategy to use.
149
+ + *VERSION*: Detect conflicts based on object versions for this resolver.
150
+ + *NONE*: Do not detect conflicts when invoking this resolver.
151
+ */
140
152
  ConflictDetection: string;
141
153
  /**
142
- * The Conflict Resolution strategy to perform in the event of a conflict.
143
- */
154
+ * The Conflict Resolution strategy to perform in the event of a conflict.
155
+ + *OPTIMISTIC_CONCURRENCY*: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
156
+ + *AUTOMERGE*: Resolve conflicts with the Automerge conflict resolution strategy.
157
+ + *LAMBDA*: Resolve conflicts with an LAMlong function supplied in the ``LambdaConflictHandlerConfig``.
158
+ */
144
159
  ConflictHandler?: string;
145
160
  /**
146
- * The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
161
+ * The ``LambdaConflictHandlerConfig`` when configuring ``LAMBDA`` as the Conflict Handler.
147
162
  */
148
163
  LambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
149
164
  };
150
165
  /**
151
- * Resource Type definition for AWS::AppSync::Resolver
166
+ * The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).
167
+ When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
168
+ See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
152
169
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html}
153
170
  */
154
171
  export declare class AppSyncResolver extends $Resource<"AWS::AppSync::Resolver", AppSyncResolverProperties, AppSyncResolverAttributes> {
@@ -1,6 +1,8 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::AppSync::Resolver
3
+ * The ``AWS::AppSync::Resolver`` resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see [Resolver Mapping Template Reference](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-mapping-template-reference.html).
4
+ When you submit an update, CFNLong updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation.
5
+ See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *User Guide*.
4
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html}
5
7
  */
6
8
  export class AppSyncResolver extends $Resource {
@@ -22,7 +22,7 @@ export type SSMDocumentProperties = {
22
22
  /**
23
23
  * The type of document to create.
24
24
  */
25
- DocumentType?: "ApplicationConfiguration" | "ApplicationConfigurationSchema" | "Automation" | "Automation.ChangeTemplate" | "ChangeCalendar" | "CloudFormation" | "Command" | "DeploymentStrategy" | "Package" | "Policy" | "ProblemAnalysis" | "ProblemAnalysisTemplate" | "Session" | "OpsPack";
25
+ DocumentType?: "ApplicationConfiguration" | "ApplicationConfigurationSchema" | "Automation" | "Automation.ChangeTemplate" | "ChangeCalendar" | "CloudFormation" | "Command" | "DeploymentStrategy" | "Package" | "Policy" | "ProblemAnalysis" | "ProblemAnalysisTemplate" | "Session";
26
26
  /**
27
27
  * A name for the Systems Manager document.
28
28
  * @pattern `^[a-zA-Z0-9_\-.]{3,128}$`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.20",
3
+ "version": "0.1.21",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },