@awboost/cfn-resource-types 0.1.49 → 0.1.50
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.
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
|
+
/**
|
|
4
|
+
* Definition of AWS::Bedrock::Agent Resource Type
|
|
5
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html}
|
|
6
|
+
*/
|
|
7
|
+
export type BedrockAgentProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* List of ActionGroups
|
|
10
|
+
*/
|
|
11
|
+
ActionGroups?: AgentActionGroup[];
|
|
12
|
+
/**
|
|
13
|
+
* Name for a resource.
|
|
14
|
+
* @pattern `^([0-9a-zA-Z][_-]?){1,100}$`
|
|
15
|
+
*/
|
|
16
|
+
AgentName: string;
|
|
17
|
+
/**
|
|
18
|
+
* ARN of a IAM role.
|
|
19
|
+
* @maxLength `2048`
|
|
20
|
+
* @pattern `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+$`
|
|
21
|
+
*/
|
|
22
|
+
AgentResourceRoleArn?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Specifies whether to automatically prepare after creating or updating the agent.
|
|
25
|
+
*/
|
|
26
|
+
AutoPrepare?: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* A KMS key ARN
|
|
29
|
+
* @minLength `1`
|
|
30
|
+
* @maxLength `2048`
|
|
31
|
+
* @pattern `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$`
|
|
32
|
+
*/
|
|
33
|
+
CustomerEncryptionKeyArn?: string;
|
|
34
|
+
/**
|
|
35
|
+
* Description of the Resource.
|
|
36
|
+
* @minLength `1`
|
|
37
|
+
* @maxLength `200`
|
|
38
|
+
*/
|
|
39
|
+
Description?: string;
|
|
40
|
+
/**
|
|
41
|
+
* ARN or name of a Bedrock model.
|
|
42
|
+
* @minLength `1`
|
|
43
|
+
* @maxLength `2048`
|
|
44
|
+
* @pattern `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$`
|
|
45
|
+
*/
|
|
46
|
+
FoundationModel?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Max Session Time.
|
|
49
|
+
* @min `60`
|
|
50
|
+
* @max `3600`
|
|
51
|
+
*/
|
|
52
|
+
IdleSessionTTLInSeconds?: number;
|
|
53
|
+
/**
|
|
54
|
+
* Instruction for the agent.
|
|
55
|
+
* @minLength `40`
|
|
56
|
+
* @maxLength `1200`
|
|
57
|
+
*/
|
|
58
|
+
Instruction?: string;
|
|
59
|
+
/**
|
|
60
|
+
* List of Agent Knowledge Bases
|
|
61
|
+
*/
|
|
62
|
+
KnowledgeBases?: AgentKnowledgeBase[];
|
|
63
|
+
/**
|
|
64
|
+
* Configuration for prompt override.
|
|
65
|
+
*/
|
|
66
|
+
PromptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
67
|
+
/**
|
|
68
|
+
* Specifies whether to allow deleting agent while it is in use.
|
|
69
|
+
*/
|
|
70
|
+
SkipResourceInUseCheckOnDelete?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* A map of tag keys and values
|
|
73
|
+
*/
|
|
74
|
+
Tags?: TagsMap;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* Attribute type definition for `AWS::Bedrock::Agent`.
|
|
78
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#aws-resource-bedrock-agent-return-values}
|
|
79
|
+
*/
|
|
80
|
+
export type BedrockAgentAttributes = {
|
|
81
|
+
/**
|
|
82
|
+
* Arn representation of the Agent.
|
|
83
|
+
* @maxLength `2048`
|
|
84
|
+
* @pattern `^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$`
|
|
85
|
+
*/
|
|
86
|
+
AgentArn: string;
|
|
87
|
+
/**
|
|
88
|
+
* Identifier for a resource.
|
|
89
|
+
* @pattern `^[0-9a-zA-Z]{10}$`
|
|
90
|
+
*/
|
|
91
|
+
AgentId: string;
|
|
92
|
+
/**
|
|
93
|
+
* Schema Type for Action APIs.
|
|
94
|
+
*/
|
|
95
|
+
AgentStatus: AgentStatus;
|
|
96
|
+
/**
|
|
97
|
+
* Draft Agent Version.
|
|
98
|
+
* @minLength `5`
|
|
99
|
+
* @maxLength `5`
|
|
100
|
+
* @pattern `^DRAFT$`
|
|
101
|
+
*/
|
|
102
|
+
AgentVersion: string;
|
|
103
|
+
/**
|
|
104
|
+
* Time Stamp.
|
|
105
|
+
*/
|
|
106
|
+
CreatedAt: string;
|
|
107
|
+
/**
|
|
108
|
+
* Failure Reasons for Error.
|
|
109
|
+
* @maxLength `2048`
|
|
110
|
+
*/
|
|
111
|
+
FailureReasons: string[];
|
|
112
|
+
/**
|
|
113
|
+
* Time Stamp.
|
|
114
|
+
*/
|
|
115
|
+
PreparedAt: string;
|
|
116
|
+
/**
|
|
117
|
+
* The recommended actions users can take to resolve an error in failureReasons.
|
|
118
|
+
* @maxLength `2048`
|
|
119
|
+
*/
|
|
120
|
+
RecommendedActions: string[];
|
|
121
|
+
/**
|
|
122
|
+
* Time Stamp.
|
|
123
|
+
*/
|
|
124
|
+
UpdatedAt: string;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Type definition for `AWS::Bedrock::Agent.ActionGroupExecutor`.
|
|
128
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html}
|
|
129
|
+
*/
|
|
130
|
+
export type ActionGroupExecutor = {
|
|
131
|
+
/**
|
|
132
|
+
* ARN of a Lambda.
|
|
133
|
+
* @maxLength `2048`
|
|
134
|
+
* @pattern `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$`
|
|
135
|
+
*/
|
|
136
|
+
Lambda: string;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Type definition for `AWS::Bedrock::Agent.ActionGroupSignature`.
|
|
140
|
+
* Action Group Signature for a BuiltIn Action
|
|
141
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupsignature.html}
|
|
142
|
+
*/
|
|
143
|
+
export type ActionGroupSignature = "AMAZON.UserInput";
|
|
144
|
+
/**
|
|
145
|
+
* Type definition for `AWS::Bedrock::Agent.ActionGroupState`.
|
|
146
|
+
* State of the action group
|
|
147
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupstate.html}
|
|
148
|
+
*/
|
|
149
|
+
export type ActionGroupState = "ENABLED" | "DISABLED";
|
|
150
|
+
/**
|
|
151
|
+
* Type definition for `AWS::Bedrock::Agent.AgentActionGroup`.
|
|
152
|
+
* Contains the information of an Agent Action Group
|
|
153
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html}
|
|
154
|
+
*/
|
|
155
|
+
export type AgentActionGroup = {
|
|
156
|
+
ActionGroupExecutor?: ActionGroupExecutor;
|
|
157
|
+
/**
|
|
158
|
+
* Name of the action group
|
|
159
|
+
* @pattern `^([0-9a-zA-Z][_-]?){1,100}$`
|
|
160
|
+
*/
|
|
161
|
+
ActionGroupName: string;
|
|
162
|
+
/**
|
|
163
|
+
* State of the action group
|
|
164
|
+
*/
|
|
165
|
+
ActionGroupState?: ActionGroupState;
|
|
166
|
+
/**
|
|
167
|
+
* Contains information about the API Schema for the Action Group
|
|
168
|
+
*/
|
|
169
|
+
ApiSchema?: APISchema;
|
|
170
|
+
/**
|
|
171
|
+
* Description of action group
|
|
172
|
+
* @minLength `1`
|
|
173
|
+
* @maxLength `200`
|
|
174
|
+
*/
|
|
175
|
+
Description?: string;
|
|
176
|
+
/**
|
|
177
|
+
* Action Group Signature for a BuiltIn Action
|
|
178
|
+
*/
|
|
179
|
+
ParentActionGroupSignature?: ActionGroupSignature;
|
|
180
|
+
/**
|
|
181
|
+
* Specifies whether to allow deleting action group while it is in use.
|
|
182
|
+
*/
|
|
183
|
+
SkipResourceInUseCheckOnDelete?: boolean;
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Type definition for `AWS::Bedrock::Agent.AgentKnowledgeBase`.
|
|
187
|
+
* Agent Knowledge Base
|
|
188
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html}
|
|
189
|
+
*/
|
|
190
|
+
export type AgentKnowledgeBase = {
|
|
191
|
+
/**
|
|
192
|
+
* Description of the Resource.
|
|
193
|
+
* @minLength `1`
|
|
194
|
+
* @maxLength `200`
|
|
195
|
+
*/
|
|
196
|
+
Description: string;
|
|
197
|
+
/**
|
|
198
|
+
* Identifier for a resource.
|
|
199
|
+
* @pattern `^[0-9a-zA-Z]{10}$`
|
|
200
|
+
*/
|
|
201
|
+
KnowledgeBaseId: string;
|
|
202
|
+
/**
|
|
203
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
204
|
+
*/
|
|
205
|
+
KnowledgeBaseState?: KnowledgeBaseState;
|
|
206
|
+
};
|
|
207
|
+
/**
|
|
208
|
+
* Type definition for `AWS::Bedrock::Agent.AgentStatus`.
|
|
209
|
+
* Schema Type for Action APIs.
|
|
210
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentstatus.html}
|
|
211
|
+
*/
|
|
212
|
+
export type AgentStatus = "CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING";
|
|
213
|
+
/**
|
|
214
|
+
* Type definition for `AWS::Bedrock::Agent.APISchema`.
|
|
215
|
+
* Contains information about the API Schema for the Action Group
|
|
216
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html}
|
|
217
|
+
*/
|
|
218
|
+
export type APISchema = {
|
|
219
|
+
/**
|
|
220
|
+
* The identifier for the S3 resource.
|
|
221
|
+
*/
|
|
222
|
+
S3: S3Identifier;
|
|
223
|
+
} | {
|
|
224
|
+
/**
|
|
225
|
+
* String OpenAPI Payload
|
|
226
|
+
*/
|
|
227
|
+
Payload: string;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* Type definition for `AWS::Bedrock::Agent.CreationMode`.
|
|
231
|
+
* Creation Mode for Prompt Configuration.
|
|
232
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-creationmode.html}
|
|
233
|
+
*/
|
|
234
|
+
export type CreationMode = "DEFAULT" | "OVERRIDDEN";
|
|
235
|
+
/**
|
|
236
|
+
* Type definition for `AWS::Bedrock::Agent.InferenceConfiguration`.
|
|
237
|
+
* Configuration for inference in prompt configuration
|
|
238
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html}
|
|
239
|
+
*/
|
|
240
|
+
export type InferenceConfiguration = {
|
|
241
|
+
/**
|
|
242
|
+
* Maximum length of output
|
|
243
|
+
* @min `0`
|
|
244
|
+
* @max `4096`
|
|
245
|
+
*/
|
|
246
|
+
MaximumLength?: number;
|
|
247
|
+
/**
|
|
248
|
+
* List of stop sequences
|
|
249
|
+
* @minLength `0`
|
|
250
|
+
* @maxLength `4`
|
|
251
|
+
*/
|
|
252
|
+
StopSequences?: string[];
|
|
253
|
+
/**
|
|
254
|
+
* Controls randomness, higher values increase diversity
|
|
255
|
+
* @min `0`
|
|
256
|
+
* @max `1`
|
|
257
|
+
*/
|
|
258
|
+
Temperature?: number;
|
|
259
|
+
/**
|
|
260
|
+
* Sample from the k most likely next tokens
|
|
261
|
+
* @min `0`
|
|
262
|
+
* @max `500`
|
|
263
|
+
*/
|
|
264
|
+
TopK?: number;
|
|
265
|
+
/**
|
|
266
|
+
* Cumulative probability cutoff for token selection
|
|
267
|
+
* @min `0`
|
|
268
|
+
* @max `1`
|
|
269
|
+
*/
|
|
270
|
+
TopP?: number;
|
|
271
|
+
};
|
|
272
|
+
/**
|
|
273
|
+
* Type definition for `AWS::Bedrock::Agent.KnowledgeBaseState`.
|
|
274
|
+
* State of the knowledge base; whether it is enabled or disabled
|
|
275
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-knowledgebasestate.html}
|
|
276
|
+
*/
|
|
277
|
+
export type KnowledgeBaseState = "ENABLED" | "DISABLED";
|
|
278
|
+
/**
|
|
279
|
+
* Type definition for `AWS::Bedrock::Agent.PromptConfiguration`.
|
|
280
|
+
* BasePromptConfiguration per Prompt Type.
|
|
281
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html}
|
|
282
|
+
*/
|
|
283
|
+
export type PromptConfiguration = {
|
|
284
|
+
/**
|
|
285
|
+
* Base Prompt Template.
|
|
286
|
+
* @minLength `1`
|
|
287
|
+
* @maxLength `100000`
|
|
288
|
+
*/
|
|
289
|
+
BasePromptTemplate?: string;
|
|
290
|
+
/**
|
|
291
|
+
* Configuration for inference in prompt configuration
|
|
292
|
+
*/
|
|
293
|
+
InferenceConfiguration?: InferenceConfiguration;
|
|
294
|
+
/**
|
|
295
|
+
* Creation Mode for Prompt Configuration.
|
|
296
|
+
*/
|
|
297
|
+
ParserMode?: CreationMode;
|
|
298
|
+
/**
|
|
299
|
+
* Creation Mode for Prompt Configuration.
|
|
300
|
+
*/
|
|
301
|
+
PromptCreationMode?: CreationMode;
|
|
302
|
+
/**
|
|
303
|
+
* Prompt State.
|
|
304
|
+
*/
|
|
305
|
+
PromptState?: PromptState;
|
|
306
|
+
/**
|
|
307
|
+
* Prompt Type.
|
|
308
|
+
*/
|
|
309
|
+
PromptType?: PromptType;
|
|
310
|
+
};
|
|
311
|
+
/**
|
|
312
|
+
* Type definition for `AWS::Bedrock::Agent.PromptOverrideConfiguration`.
|
|
313
|
+
* Configuration for prompt override.
|
|
314
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html}
|
|
315
|
+
*/
|
|
316
|
+
export type PromptOverrideConfiguration = {
|
|
317
|
+
/**
|
|
318
|
+
* ARN of a Lambda.
|
|
319
|
+
* @maxLength `2048`
|
|
320
|
+
* @pattern `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$`
|
|
321
|
+
*/
|
|
322
|
+
OverrideLambda?: string;
|
|
323
|
+
/**
|
|
324
|
+
* List of BasePromptConfiguration
|
|
325
|
+
* @maxLength `10`
|
|
326
|
+
*/
|
|
327
|
+
PromptConfigurations: PromptConfiguration[];
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* Type definition for `AWS::Bedrock::Agent.PromptState`.
|
|
331
|
+
* Prompt State.
|
|
332
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptstate.html}
|
|
333
|
+
*/
|
|
334
|
+
export type PromptState = "ENABLED" | "DISABLED";
|
|
335
|
+
/**
|
|
336
|
+
* Type definition for `AWS::Bedrock::Agent.PromptType`.
|
|
337
|
+
* Prompt Type.
|
|
338
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-prompttype.html}
|
|
339
|
+
*/
|
|
340
|
+
export type PromptType = "PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "KNOWLEDGE_BASE_RESPONSE_GENERATION";
|
|
341
|
+
/**
|
|
342
|
+
* Type definition for `AWS::Bedrock::Agent.S3Identifier`.
|
|
343
|
+
* The identifier for the S3 resource.
|
|
344
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html}
|
|
345
|
+
*/
|
|
346
|
+
export type S3Identifier = {
|
|
347
|
+
/**
|
|
348
|
+
* A bucket in S3.
|
|
349
|
+
* @minLength `3`
|
|
350
|
+
* @maxLength `63`
|
|
351
|
+
* @pattern `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$`
|
|
352
|
+
*/
|
|
353
|
+
S3BucketName?: string;
|
|
354
|
+
/**
|
|
355
|
+
* A object key in S3.
|
|
356
|
+
* @minLength `1`
|
|
357
|
+
* @maxLength `1024`
|
|
358
|
+
* @pattern `^[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$`
|
|
359
|
+
*/
|
|
360
|
+
S3ObjectKey?: string;
|
|
361
|
+
};
|
|
362
|
+
/**
|
|
363
|
+
* Type definition for `AWS::Bedrock::Agent.TagsMap`.
|
|
364
|
+
* A map of tag keys and values
|
|
365
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-tagsmap.html}
|
|
366
|
+
*/
|
|
367
|
+
export type TagsMap = Record<string, string>;
|
|
368
|
+
/**
|
|
369
|
+
* Definition of AWS::Bedrock::Agent Resource Type
|
|
370
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html}
|
|
371
|
+
*/
|
|
372
|
+
export declare class BedrockAgent extends $Resource<"AWS::Bedrock::Agent", BedrockAgentProperties, BedrockAgentAttributes> {
|
|
373
|
+
static readonly Type = "AWS::Bedrock::Agent";
|
|
374
|
+
constructor(logicalId: string, properties: BedrockAgentProperties, options?: $ResourceOptions);
|
|
375
|
+
}
|
|
376
|
+
//# sourceMappingURL=AWS-Bedrock-Agent.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
/**
|
|
3
|
+
* Definition of AWS::Bedrock::Agent Resource Type
|
|
4
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html}
|
|
5
|
+
*/
|
|
6
|
+
export class BedrockAgent extends $Resource {
|
|
7
|
+
static Type = "AWS::Bedrock::Agent";
|
|
8
|
+
constructor(logicalId, properties, options) {
|
|
9
|
+
super(logicalId, BedrockAgent.Type, properties, options);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=AWS-Bedrock-Agent.js.map
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
|
+
/**
|
|
4
|
+
* Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
|
|
5
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html}
|
|
6
|
+
*/
|
|
7
|
+
export type CodeConnectionsConnectionProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* The name of the connection. Connection names must be unique in an AWS user account.
|
|
10
|
+
* @minLength `1`
|
|
11
|
+
* @maxLength `32`
|
|
12
|
+
*/
|
|
13
|
+
ConnectionName: string;
|
|
14
|
+
/**
|
|
15
|
+
* The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
|
|
16
|
+
* @minLength `0`
|
|
17
|
+
* @maxLength `256`
|
|
18
|
+
* @pattern `arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+`
|
|
19
|
+
*/
|
|
20
|
+
HostArn?: string;
|
|
21
|
+
/**
|
|
22
|
+
* The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
|
|
23
|
+
*/
|
|
24
|
+
ProviderType?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Specifies the tags applied to a connection.
|
|
27
|
+
*/
|
|
28
|
+
Tags?: Tag[];
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Attribute type definition for `AWS::CodeConnections::Connection`.
|
|
32
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#aws-resource-codeconnections-connection-return-values}
|
|
33
|
+
*/
|
|
34
|
+
export type CodeConnectionsConnectionAttributes = {
|
|
35
|
+
/**
|
|
36
|
+
* The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
|
|
37
|
+
* @minLength `0`
|
|
38
|
+
* @maxLength `256`
|
|
39
|
+
* @pattern `arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+`
|
|
40
|
+
*/
|
|
41
|
+
ConnectionArn: string;
|
|
42
|
+
/**
|
|
43
|
+
* The current status of the connection.
|
|
44
|
+
*/
|
|
45
|
+
ConnectionStatus: string;
|
|
46
|
+
/**
|
|
47
|
+
* The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
|
|
48
|
+
* @minLength `12`
|
|
49
|
+
* @maxLength `12`
|
|
50
|
+
* @pattern `[0-9]{12}`
|
|
51
|
+
*/
|
|
52
|
+
OwnerAccountId: string;
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Type definition for `AWS::CodeConnections::Connection.Tag`.
|
|
56
|
+
* A key-value pair to associate with a resource.
|
|
57
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeconnections-connection-tag.html}
|
|
58
|
+
*/
|
|
59
|
+
export type Tag = {
|
|
60
|
+
/**
|
|
61
|
+
* The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
|
|
62
|
+
* @minLength `1`
|
|
63
|
+
* @maxLength `128`
|
|
64
|
+
*/
|
|
65
|
+
Key: string;
|
|
66
|
+
/**
|
|
67
|
+
* The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
|
|
68
|
+
* @minLength `0`
|
|
69
|
+
* @maxLength `256`
|
|
70
|
+
*/
|
|
71
|
+
Value: string;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
|
|
75
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html}
|
|
76
|
+
*/
|
|
77
|
+
export declare class CodeConnectionsConnection extends $Resource<"AWS::CodeConnections::Connection", CodeConnectionsConnectionProperties, CodeConnectionsConnectionAttributes> {
|
|
78
|
+
static readonly Type = "AWS::CodeConnections::Connection";
|
|
79
|
+
constructor(logicalId: string, properties: CodeConnectionsConnectionProperties, options?: $ResourceOptions);
|
|
80
|
+
}
|
|
81
|
+
//# sourceMappingURL=AWS-CodeConnections-Connection.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
/**
|
|
3
|
+
* Schema for AWS::CodeConnections::Connection resource which can be used to connect external source providers with other AWS services (i.e. AWS CodePipeline)
|
|
4
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html}
|
|
5
|
+
*/
|
|
6
|
+
export class CodeConnectionsConnection extends $Resource {
|
|
7
|
+
static Type = "AWS::CodeConnections::Connection";
|
|
8
|
+
constructor(logicalId, properties, options) {
|
|
9
|
+
super(logicalId, CodeConnectionsConnection.Type, properties, options);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=AWS-CodeConnections-Connection.js.map
|