UNPKG

57.5 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnCustomActionType`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html
10 */
11export interface CfnCustomActionTypeProps {
12 /**
13 * The category of the custom action, such as a build action or a test action.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category
16 */
17 readonly category: string;
18 /**
19 * The details of the input artifact for the action, such as its commit ID.
20 *
21 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails
22 */
23 readonly inputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
24 /**
25 * The details of the output artifact of the action, such as its commit ID.
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails
28 */
29 readonly outputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
30 /**
31 * The provider of the service used in the custom action, such as CodeDeploy.
32 *
33 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider
34 */
35 readonly provider: string;
36 /**
37 * The version identifier of the custom action.
38 *
39 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version
40 */
41 readonly version: string;
42 /**
43 * The configuration properties for the custom action.
44 *
45 * > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .
46 *
47 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties
48 */
49 readonly configurationProperties?: Array<CfnCustomActionType.ConfigurationPropertiesProperty | cdk.IResolvable> | cdk.IResolvable;
50 /**
51 * URLs that provide users information about this custom action.
52 *
53 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings
54 */
55 readonly settings?: CfnCustomActionType.SettingsProperty | cdk.IResolvable;
56 /**
57 * The tags for the custom action.
58 *
59 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags
60 */
61 readonly tags?: cdk.CfnTag[];
62}
63/**
64 * A CloudFormation `AWS::CodePipeline::CustomActionType`
65 *
66 * The `AWS::CodePipeline::CustomActionType` resource creates a custom action for activities that aren't included in the CodePipeline default actions, such as running an internally developed build process or a test suite. You can use these custom actions in the stage of a pipeline. For more information, see [Create and Add a Custom Action in AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) in the *AWS CodePipeline User Guide* .
67 *
68 * @cloudformationResource AWS::CodePipeline::CustomActionType
69 * @stability external
70 *
71 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html
72 */
73export declare class CfnCustomActionType extends cdk.CfnResource implements cdk.IInspectable {
74 /**
75 * The CloudFormation resource type name for this resource class.
76 */
77 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodePipeline::CustomActionType";
78 /**
79 * A factory method that creates a new instance of this class from an object
80 * containing the CloudFormation properties of this resource.
81 * Used in the @aws-cdk/cloudformation-include module.
82 *
83 * @internal
84 */
85 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCustomActionType;
86 /**
87 * The category of the custom action, such as a build action or a test action.
88 *
89 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category
90 */
91 category: string;
92 /**
93 * The details of the input artifact for the action, such as its commit ID.
94 *
95 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails
96 */
97 inputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
98 /**
99 * The details of the output artifact of the action, such as its commit ID.
100 *
101 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails
102 */
103 outputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
104 /**
105 * The provider of the service used in the custom action, such as CodeDeploy.
106 *
107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider
108 */
109 provider: string;
110 /**
111 * The version identifier of the custom action.
112 *
113 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version
114 */
115 version: string;
116 /**
117 * The configuration properties for the custom action.
118 *
119 * > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .
120 *
121 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties
122 */
123 configurationProperties: Array<CfnCustomActionType.ConfigurationPropertiesProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
124 /**
125 * URLs that provide users information about this custom action.
126 *
127 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings
128 */
129 settings: CfnCustomActionType.SettingsProperty | cdk.IResolvable | undefined;
130 /**
131 * The tags for the custom action.
132 *
133 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags
134 */
135 readonly tags: cdk.TagManager;
136 /**
137 * Create a new `AWS::CodePipeline::CustomActionType`.
138 *
139 * @param scope - scope in which this resource is defined
140 * @param id - scoped id of the resource
141 * @param props - resource properties
142 */
143 constructor(scope: cdk.Construct, id: string, props: CfnCustomActionTypeProps);
144 /**
145 * Examines the CloudFormation resource and discloses attributes.
146 *
147 * @param inspector - tree inspector to collect and process attributes
148 *
149 */
150 inspect(inspector: cdk.TreeInspector): void;
151 protected get cfnProperties(): {
152 [key: string]: any;
153 };
154 protected renderProperties(props: {
155 [key: string]: any;
156 }): {
157 [key: string]: any;
158 };
159}
160export declare namespace CfnCustomActionType {
161 /**
162 * Returns information about the details of an artifact.
163 *
164 * @struct
165 * @stability external
166 *
167 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html
168 */
169 interface ArtifactDetailsProperty {
170 /**
171 * The maximum number of artifacts allowed for the action type.
172 *
173 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount
174 */
175 readonly maximumCount: number;
176 /**
177 * The minimum number of artifacts allowed for the action type.
178 *
179 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount
180 */
181 readonly minimumCount: number;
182 }
183}
184export declare namespace CfnCustomActionType {
185 /**
186 * The configuration properties for the custom action.
187 *
188 * > You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html) .
189 *
190 * @struct
191 * @stability external
192 *
193 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html
194 */
195 interface ConfigurationPropertiesProperty {
196 /**
197 * The description of the action configuration property that is displayed to users.
198 *
199 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description
200 */
201 readonly description?: string;
202 /**
203 * Whether the configuration property is a key.
204 *
205 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key
206 */
207 readonly key: boolean | cdk.IResolvable;
208 /**
209 * The name of the action configuration property.
210 *
211 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name
212 */
213 readonly name: string;
214 /**
215 * Indicates that the property is used with `PollForJobs` . When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
216 *
217 * If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
218 *
219 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable
220 */
221 readonly queryable?: boolean | cdk.IResolvable;
222 /**
223 * Whether the configuration property is a required value.
224 *
225 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required
226 */
227 readonly required: boolean | cdk.IResolvable;
228 /**
229 * Whether the configuration property is secret. Secrets are hidden from all calls except for `GetJobDetails` , `GetThirdPartyJobDetails` , `PollForJobs` , and `PollForThirdPartyJobs` .
230 *
231 * When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
232 *
233 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret
234 */
235 readonly secret: boolean | cdk.IResolvable;
236 /**
237 * The type of the configuration property.
238 *
239 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type
240 */
241 readonly type?: string;
242 }
243}
244export declare namespace CfnCustomActionType {
245 /**
246 * `Settings` is a property of the `AWS::CodePipeline::CustomActionType` resource that provides URLs that users can access to view information about the CodePipeline custom action.
247 *
248 * @struct
249 * @stability external
250 *
251 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html
252 */
253 interface SettingsProperty {
254 /**
255 * The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
256 *
257 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate
258 */
259 readonly entityUrlTemplate?: string;
260 /**
261 * The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.
262 *
263 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate
264 */
265 readonly executionUrlTemplate?: string;
266 /**
267 * The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
268 *
269 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate
270 */
271 readonly revisionUrlTemplate?: string;
272 /**
273 * The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
274 *
275 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl
276 */
277 readonly thirdPartyConfigurationUrl?: string;
278 }
279}
280/**
281 * Properties for defining a `CfnPipeline`
282 *
283 * @struct
284 * @stability external
285 *
286 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
287 */
288export interface CfnPipelineProps {
289 /**
290 * The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no `actionRoleArn` , or to use to assume roles for actions with an `actionRoleArn` .
291 *
292 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn
293 */
294 readonly roleArn: string;
295 /**
296 * Represents information about a stage and its definition.
297 *
298 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages
299 */
300 readonly stages: Array<CfnPipeline.StageDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
301 /**
302 * The S3 bucket where artifacts for the pipeline are stored.
303 *
304 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
305 *
306 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore
307 */
308 readonly artifactStore?: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
309 /**
310 * A mapping of `artifactStore` objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
311 *
312 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
313 *
314 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores
315 */
316 readonly artifactStores?: Array<CfnPipeline.ArtifactStoreMapProperty | cdk.IResolvable> | cdk.IResolvable;
317 /**
318 * Represents the input of a `DisableStageTransition` action.
319 *
320 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions
321 */
322 readonly disableInboundStageTransitions?: Array<CfnPipeline.StageTransitionProperty | cdk.IResolvable> | cdk.IResolvable;
323 /**
324 * The name of the pipeline.
325 *
326 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name
327 */
328 readonly name?: string;
329 /**
330 * Indicates whether to rerun the CodePipeline pipeline after you update it.
331 *
332 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate
333 */
334 readonly restartExecutionOnUpdate?: boolean | cdk.IResolvable;
335 /**
336 * Specifies the tags applied to the pipeline.
337 *
338 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags
339 */
340 readonly tags?: cdk.CfnTag[];
341}
342/**
343 * A CloudFormation `AWS::CodePipeline::Pipeline`
344 *
345 * The `AWS::CodePipeline::Pipeline` resource creates a CodePipeline pipeline that describes how software changes go through a release process. For more information, see [What Is CodePipeline?](https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html) in the *AWS CodePipeline User Guide* .
346 *
347 * @cloudformationResource AWS::CodePipeline::Pipeline
348 * @stability external
349 *
350 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
351 */
352export declare class CfnPipeline extends cdk.CfnResource implements cdk.IInspectable {
353 /**
354 * The CloudFormation resource type name for this resource class.
355 */
356 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodePipeline::Pipeline";
357 /**
358 * A factory method that creates a new instance of this class from an object
359 * containing the CloudFormation properties of this resource.
360 * Used in the @aws-cdk/cloudformation-include module.
361 *
362 * @internal
363 */
364 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPipeline;
365 /**
366 * The version of the pipeline.
367 *
368 * > A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
369 * @cloudformationAttribute Version
370 */
371 readonly attrVersion: string;
372 /**
373 * The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no `actionRoleArn` , or to use to assume roles for actions with an `actionRoleArn` .
374 *
375 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn
376 */
377 roleArn: string;
378 /**
379 * Represents information about a stage and its definition.
380 *
381 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages
382 */
383 stages: Array<CfnPipeline.StageDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
384 /**
385 * The S3 bucket where artifacts for the pipeline are stored.
386 *
387 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
388 *
389 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore
390 */
391 artifactStore: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable | undefined;
392 /**
393 * A mapping of `artifactStore` objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
394 *
395 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
396 *
397 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores
398 */
399 artifactStores: Array<CfnPipeline.ArtifactStoreMapProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
400 /**
401 * Represents the input of a `DisableStageTransition` action.
402 *
403 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions
404 */
405 disableInboundStageTransitions: Array<CfnPipeline.StageTransitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
406 /**
407 * The name of the pipeline.
408 *
409 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name
410 */
411 name: string | undefined;
412 /**
413 * Indicates whether to rerun the CodePipeline pipeline after you update it.
414 *
415 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate
416 */
417 restartExecutionOnUpdate: boolean | cdk.IResolvable | undefined;
418 /**
419 * Specifies the tags applied to the pipeline.
420 *
421 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags
422 */
423 readonly tags: cdk.TagManager;
424 /**
425 * Create a new `AWS::CodePipeline::Pipeline`.
426 *
427 * @param scope - scope in which this resource is defined
428 * @param id - scoped id of the resource
429 * @param props - resource properties
430 */
431 constructor(scope: cdk.Construct, id: string, props: CfnPipelineProps);
432 /**
433 * Examines the CloudFormation resource and discloses attributes.
434 *
435 * @param inspector - tree inspector to collect and process attributes
436 *
437 */
438 inspect(inspector: cdk.TreeInspector): void;
439 protected get cfnProperties(): {
440 [key: string]: any;
441 };
442 protected renderProperties(props: {
443 [key: string]: any;
444 }): {
445 [key: string]: any;
446 };
447}
448export declare namespace CfnPipeline {
449 /**
450 * Represents information about an action declaration.
451 *
452 * @struct
453 * @stability external
454 *
455 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html
456 */
457 interface ActionDeclarationProperty {
458 /**
459 * Specifies the action type and the provider of the action.
460 *
461 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid
462 */
463 readonly actionTypeId: CfnPipeline.ActionTypeIdProperty | cdk.IResolvable;
464 /**
465 * The action's configuration. These are key-value pairs that specify input values for an action. For more information, see [Action Structure Requirements in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) . For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) in the *AWS CloudFormation User Guide* . For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) in the *AWS CloudFormation User Guide* .
466 *
467 * The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
468 *
469 * *JSON:*
470 *
471 * `"Configuration" : { Key : Value },`
472 *
473 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration
474 */
475 readonly configuration?: any | cdk.IResolvable;
476 /**
477 * The name or ID of the artifact consumed by the action, such as a test or build artifact.
478 *
479 * > For a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide* .
480 *
481 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts
482 */
483 readonly inputArtifacts?: Array<CfnPipeline.InputArtifactProperty | cdk.IResolvable> | cdk.IResolvable;
484 /**
485 * The action declaration's name.
486 *
487 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name
488 */
489 readonly name: string;
490 /**
491 * The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
492 *
493 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace
494 */
495 readonly namespace?: string;
496 /**
497 * The name or ID of the result of the action declaration, such as a test or build artifact.
498 *
499 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts
500 */
501 readonly outputArtifacts?: Array<CfnPipeline.OutputArtifactProperty | cdk.IResolvable> | cdk.IResolvable;
502 /**
503 * The action declaration's AWS Region, such as us-east-1.
504 *
505 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-region
506 */
507 readonly region?: string;
508 /**
509 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
510 *
511 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn
512 */
513 readonly roleArn?: string;
514 /**
515 * The order in which actions are run.
516 *
517 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder
518 */
519 readonly runOrder?: number;
520 }
521}
522export declare namespace CfnPipeline {
523 /**
524 * Represents information about an action type.
525 *
526 * @struct
527 * @stability external
528 *
529 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html
530 */
531 interface ActionTypeIdProperty {
532 /**
533 * A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.
534 *
535 * - `Source`
536 * - `Build`
537 * - `Test`
538 * - `Deploy`
539 * - `Invoke`
540 * - `Approval`
541 *
542 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category
543 */
544 readonly category: string;
545 /**
546 * The creator of the action being called. There are three valid values for the `Owner` field in the action category section within your pipeline structure: `AWS` , `ThirdParty` , and `Custom` . For more information, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) .
547 *
548 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner
549 */
550 readonly owner: string;
551 /**
552 * The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as `CodeDeploy` . For more information, see [Valid Action Types and Providers in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#actions-valid-providers) .
553 *
554 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider
555 */
556 readonly provider: string;
557 /**
558 * A string that describes the action version.
559 *
560 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version
561 */
562 readonly version: string;
563 }
564}
565export declare namespace CfnPipeline {
566 /**
567 * The S3 bucket where artifacts for the pipeline are stored.
568 *
569 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
570 *
571 * @struct
572 * @stability external
573 *
574 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html
575 */
576 interface ArtifactStoreProperty {
577 /**
578 * The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key. If this is undefined, the default key for Amazon S3 is used. To see an example artifact store encryption key field, see the example structure here: [AWS::CodePipeline::Pipeline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html) .
579 *
580 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey
581 */
582 readonly encryptionKey?: CfnPipeline.EncryptionKeyProperty | cdk.IResolvable;
583 /**
584 * The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
585 *
586 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location
587 */
588 readonly location: string;
589 /**
590 * The type of the artifact store, such as S3.
591 *
592 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type
593 */
594 readonly type: string;
595 }
596}
597export declare namespace CfnPipeline {
598 /**
599 * A mapping of `artifactStore` objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
600 *
601 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
602 *
603 * @struct
604 * @stability external
605 *
606 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html
607 */
608 interface ArtifactStoreMapProperty {
609 /**
610 * Represents information about the S3 bucket where artifacts are stored for the pipeline.
611 *
612 * > You must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use `artifactStores` .
613 *
614 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore
615 */
616 readonly artifactStore: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
617 /**
618 * The action declaration's AWS Region, such as us-east-1.
619 *
620 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region
621 */
622 readonly region: string;
623 }
624}
625export declare namespace CfnPipeline {
626 /**
627 * Reserved for future use.
628 *
629 * @struct
630 * @stability external
631 *
632 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html
633 */
634 interface BlockerDeclarationProperty {
635 /**
636 * Reserved for future use.
637 *
638 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name
639 */
640 readonly name: string;
641 /**
642 * Reserved for future use.
643 *
644 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type
645 */
646 readonly type: string;
647 }
648}
649export declare namespace CfnPipeline {
650 /**
651 * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
652 *
653 * `EncryptionKey` is a property of the [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) property type.
654 *
655 * @struct
656 * @stability external
657 *
658 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html
659 */
660 interface EncryptionKeyProperty {
661 /**
662 * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
663 *
664 * > Aliases are recognized only in the account that created the AWS KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key.
665 *
666 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id
667 */
668 readonly id: string;
669 /**
670 * The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
671 *
672 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type
673 */
674 readonly type: string;
675 }
676}
677export declare namespace CfnPipeline {
678 /**
679 * Represents information about an artifact to be worked on, such as a test or build artifact.
680 *
681 * @struct
682 * @stability external
683 *
684 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html
685 */
686 interface InputArtifactProperty {
687 /**
688 * The name of the artifact to be worked on (for example, "My App").
689 *
690 * The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
691 *
692 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name
693 */
694 readonly name: string;
695 }
696}
697export declare namespace CfnPipeline {
698 /**
699 * Represents information about the output of an action.
700 *
701 * @struct
702 * @stability external
703 *
704 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html
705 */
706 interface OutputArtifactProperty {
707 /**
708 * The name of the output of an artifact, such as "My App".
709 *
710 * The output artifact name must exactly match the input artifact declared for a downstream action. However, the downstream action's input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
711 *
712 * Output artifact names must be unique within a pipeline.
713 *
714 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name
715 */
716 readonly name: string;
717 }
718}
719export declare namespace CfnPipeline {
720 /**
721 * Represents information about a stage and its definition.
722 *
723 * @struct
724 * @stability external
725 *
726 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html
727 */
728 interface StageDeclarationProperty {
729 /**
730 * The actions included in a stage.
731 *
732 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions
733 */
734 readonly actions: Array<CfnPipeline.ActionDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
735 /**
736 * Reserved for future use.
737 *
738 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers
739 */
740 readonly blockers?: Array<CfnPipeline.BlockerDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
741 /**
742 * The name of the stage.
743 *
744 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name
745 */
746 readonly name: string;
747 }
748}
749export declare namespace CfnPipeline {
750 /**
751 * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
752 *
753 * @struct
754 * @stability external
755 *
756 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html
757 */
758 interface StageTransitionProperty {
759 /**
760 * The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
761 *
762 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason
763 */
764 readonly reason: string;
765 /**
766 * The name of the stage where you want to disable the inbound or outbound transition of artifacts.
767 *
768 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename
769 */
770 readonly stageName: string;
771 }
772}
773/**
774 * Properties for defining a `CfnWebhook`
775 *
776 * @struct
777 * @stability external
778 *
779 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html
780 */
781export interface CfnWebhookProps {
782 /**
783 * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
784 *
785 * - For information about the authentication scheme implemented by GITHUB_HMAC, see [Securing your webhooks](https://docs.aws.amazon.com/https://developer.github.com/webhooks/securing/) on the GitHub Developer website.
786 * - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
787 * - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
788 *
789 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication
790 */
791 readonly authentication: string;
792 /**
793 * Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the `SecretToken` property must be set. For IP, only the `AllowedIPRange` property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
794 *
795 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration
796 */
797 readonly authenticationConfiguration: CfnWebhook.WebhookAuthConfigurationProperty | cdk.IResolvable;
798 /**
799 * A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
800 *
801 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters
802 */
803 readonly filters: Array<CfnWebhook.WebhookFilterRuleProperty | cdk.IResolvable> | cdk.IResolvable;
804 /**
805 * The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
806 *
807 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction
808 */
809 readonly targetAction: string;
810 /**
811 * The name of the pipeline you want to connect to the webhook.
812 *
813 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline
814 */
815 readonly targetPipeline: string;
816 /**
817 * The version number of the pipeline to be connected to the trigger request.
818 *
819 * Required: Yes
820 *
821 * Type: Integer
822 *
823 * Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
824 *
825 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion
826 */
827 readonly targetPipelineVersion: number;
828 /**
829 * The name of the webhook.
830 *
831 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name
832 */
833 readonly name?: string;
834 /**
835 * Configures a connection between the webhook that was created and the external tool with events to be detected.
836 *
837 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty
838 */
839 readonly registerWithThirdParty?: boolean | cdk.IResolvable;
840}
841/**
842 * A CloudFormation `AWS::CodePipeline::Webhook`
843 *
844 * The `AWS::CodePipeline::Webhook` resource creates and registers your webhook. After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see [Configure Your GitHub Pipelines to Use Webhooks for Change Detection](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-webhooks-migration.html) in the *AWS CodePipeline User Guide* .
845 *
846 * We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .
847 *
848 * > When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials.
849 *
850 * @cloudformationResource AWS::CodePipeline::Webhook
851 * @stability external
852 *
853 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html
854 */
855export declare class CfnWebhook extends cdk.CfnResource implements cdk.IInspectable {
856 /**
857 * The CloudFormation resource type name for this resource class.
858 */
859 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodePipeline::Webhook";
860 /**
861 * A factory method that creates a new instance of this class from an object
862 * containing the CloudFormation properties of this resource.
863 * Used in the @aws-cdk/cloudformation-include module.
864 *
865 * @internal
866 */
867 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnWebhook;
868 /**
869 * The webhook URL generated by AWS CodePipeline , such as `https://eu-central-1.webhooks.aws/trigger123456` .
870 * @cloudformationAttribute Url
871 */
872 readonly attrUrl: string;
873 /**
874 * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
875 *
876 * - For information about the authentication scheme implemented by GITHUB_HMAC, see [Securing your webhooks](https://docs.aws.amazon.com/https://developer.github.com/webhooks/securing/) on the GitHub Developer website.
877 * - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
878 * - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
879 *
880 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication
881 */
882 authentication: string;
883 /**
884 * Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the `SecretToken` property must be set. For IP, only the `AllowedIPRange` property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
885 *
886 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration
887 */
888 authenticationConfiguration: CfnWebhook.WebhookAuthConfigurationProperty | cdk.IResolvable;
889 /**
890 * A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
891 *
892 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters
893 */
894 filters: Array<CfnWebhook.WebhookFilterRuleProperty | cdk.IResolvable> | cdk.IResolvable;
895 /**
896 * The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
897 *
898 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction
899 */
900 targetAction: string;
901 /**
902 * The name of the pipeline you want to connect to the webhook.
903 *
904 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline
905 */
906 targetPipeline: string;
907 /**
908 * The version number of the pipeline to be connected to the trigger request.
909 *
910 * Required: Yes
911 *
912 * Type: Integer
913 *
914 * Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
915 *
916 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion
917 */
918 targetPipelineVersion: number;
919 /**
920 * The name of the webhook.
921 *
922 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name
923 */
924 name: string | undefined;
925 /**
926 * Configures a connection between the webhook that was created and the external tool with events to be detected.
927 *
928 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty
929 */
930 registerWithThirdParty: boolean | cdk.IResolvable | undefined;
931 /**
932 * Create a new `AWS::CodePipeline::Webhook`.
933 *
934 * @param scope - scope in which this resource is defined
935 * @param id - scoped id of the resource
936 * @param props - resource properties
937 */
938 constructor(scope: cdk.Construct, id: string, props: CfnWebhookProps);
939 /**
940 * Examines the CloudFormation resource and discloses attributes.
941 *
942 * @param inspector - tree inspector to collect and process attributes
943 *
944 */
945 inspect(inspector: cdk.TreeInspector): void;
946 protected get cfnProperties(): {
947 [key: string]: any;
948 };
949 protected renderProperties(props: {
950 [key: string]: any;
951 }): {
952 [key: string]: any;
953 };
954}
955export declare namespace CfnWebhook {
956 /**
957 * The authentication applied to incoming webhook trigger requests.
958 *
959 * @struct
960 * @stability external
961 *
962 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html
963 */
964 interface WebhookAuthConfigurationProperty {
965 /**
966 * The property used to configure acceptance of webhooks in an IP address range. For IP, only the `AllowedIPRange` property must be set. This property must be set to a valid CIDR range.
967 *
968 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange
969 */
970 readonly allowedIpRange?: string;
971 /**
972 * The property used to configure GitHub authentication. For GITHUB_HMAC, only the `SecretToken` property must be set.
973 *
974 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken
975 */
976 readonly secretToken?: string;
977 }
978}
979export declare namespace CfnWebhook {
980 /**
981 * The event criteria that specify when a webhook notification is sent to your URL.
982 *
983 * @struct
984 * @stability external
985 *
986 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html
987 */
988 interface WebhookFilterRuleProperty {
989 /**
990 * A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the `MatchEquals` field. Otherwise, the request is ignored. For more information, see [Java JsonPath implementation](https://docs.aws.amazon.com/https://github.com/json-path/JsonPath) in GitHub.
991 *
992 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath
993 */
994 readonly jsonPath: string;
995 /**
996 * The value selected by the `JsonPath` expression must match what is supplied in the `MatchEquals` field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the `MatchEquals` value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see [Pipeline Structure Reference Action Requirements](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements) .
997 *
998 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals
999 */
1000 readonly matchEquals?: string;
1001 }
1002}