UNPKG

58.9 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 *
88 * @cloudformationAttribute Id
89 */
90 readonly attrId: string;
91 /**
92 * The category of the custom action, such as a build action or a test action.
93 *
94 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-category
95 */
96 category: string;
97 /**
98 * The details of the input artifact for the action, such as its commit ID.
99 *
100 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-inputartifactdetails
101 */
102 inputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
103 /**
104 * The details of the output artifact of the action, such as its commit ID.
105 *
106 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-outputartifactdetails
107 */
108 outputArtifactDetails: CfnCustomActionType.ArtifactDetailsProperty | cdk.IResolvable;
109 /**
110 * The provider of the service used in the custom action, such as CodeDeploy.
111 *
112 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-provider
113 */
114 provider: string;
115 /**
116 * The version identifier of the custom action.
117 *
118 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-version
119 */
120 version: string;
121 /**
122 * The configuration properties for the custom action.
123 *
124 * > 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) .
125 *
126 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-configurationproperties
127 */
128 configurationProperties: Array<CfnCustomActionType.ConfigurationPropertiesProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
129 /**
130 * URLs that provide users information about this custom action.
131 *
132 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-settings
133 */
134 settings: CfnCustomActionType.SettingsProperty | cdk.IResolvable | undefined;
135 /**
136 * The tags for the custom action.
137 *
138 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-customactiontype.html#cfn-codepipeline-customactiontype-tags
139 */
140 readonly tags: cdk.TagManager;
141 /**
142 * Create a new `AWS::CodePipeline::CustomActionType`.
143 *
144 * @param scope - scope in which this resource is defined
145 * @param id - scoped id of the resource
146 * @param props - resource properties
147 */
148 constructor(scope: cdk.Construct, id: string, props: CfnCustomActionTypeProps);
149 /**
150 * Examines the CloudFormation resource and discloses attributes.
151 *
152 * @param inspector - tree inspector to collect and process attributes
153 *
154 */
155 inspect(inspector: cdk.TreeInspector): void;
156 protected get cfnProperties(): {
157 [key: string]: any;
158 };
159 protected renderProperties(props: {
160 [key: string]: any;
161 }): {
162 [key: string]: any;
163 };
164}
165export declare namespace CfnCustomActionType {
166 /**
167 * Returns information about the details of an artifact.
168 *
169 * @struct
170 * @stability external
171 *
172 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html
173 */
174 interface ArtifactDetailsProperty {
175 /**
176 * The maximum number of artifacts allowed for the action type.
177 *
178 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-maximumcount
179 */
180 readonly maximumCount: number;
181 /**
182 * The minimum number of artifacts allowed for the action type.
183 *
184 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-artifactdetails.html#cfn-codepipeline-customactiontype-artifactdetails-minimumcount
185 */
186 readonly minimumCount: number;
187 }
188}
189export declare namespace CfnCustomActionType {
190 /**
191 * The configuration properties for the custom action.
192 *
193 * > 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) .
194 *
195 * @struct
196 * @stability external
197 *
198 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html
199 */
200 interface ConfigurationPropertiesProperty {
201 /**
202 * The description of the action configuration property that is displayed to users.
203 *
204 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-description
205 */
206 readonly description?: string;
207 /**
208 * Whether the configuration property is a key.
209 *
210 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-key
211 */
212 readonly key: boolean | cdk.IResolvable;
213 /**
214 * The name of the action configuration property.
215 *
216 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-name
217 */
218 readonly name: string;
219 /**
220 * 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.
221 *
222 * 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.
223 *
224 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-queryable
225 */
226 readonly queryable?: boolean | cdk.IResolvable;
227 /**
228 * Whether the configuration property is a required value.
229 *
230 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-required
231 */
232 readonly required: boolean | cdk.IResolvable;
233 /**
234 * Whether the configuration property is secret. Secrets are hidden from all calls except for `GetJobDetails` , `GetThirdPartyJobDetails` , `PollForJobs` , and `PollForThirdPartyJobs` .
235 *
236 * When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
237 *
238 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-secret
239 */
240 readonly secret: boolean | cdk.IResolvable;
241 /**
242 * The type of the configuration property.
243 *
244 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-configurationproperties.html#cfn-codepipeline-customactiontype-configurationproperties-type
245 */
246 readonly type?: string;
247 }
248}
249export declare namespace CfnCustomActionType {
250 /**
251 * `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.
252 *
253 * @struct
254 * @stability external
255 *
256 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html
257 */
258 interface SettingsProperty {
259 /**
260 * 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.
261 *
262 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-entityurltemplate
263 */
264 readonly entityUrlTemplate?: string;
265 /**
266 * 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.
267 *
268 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-executionurltemplate
269 */
270 readonly executionUrlTemplate?: string;
271 /**
272 * 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.
273 *
274 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-revisionurltemplate
275 */
276 readonly revisionUrlTemplate?: string;
277 /**
278 * 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.
279 *
280 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-customactiontype-settings.html#cfn-codepipeline-customactiontype-settings-thirdpartyconfigurationurl
281 */
282 readonly thirdPartyConfigurationUrl?: string;
283 }
284}
285/**
286 * Properties for defining a `CfnPipeline`
287 *
288 * @struct
289 * @stability external
290 *
291 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
292 */
293export interface CfnPipelineProps {
294 /**
295 * 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` .
296 *
297 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn
298 */
299 readonly roleArn: string;
300 /**
301 * Represents information about a stage and its definition.
302 *
303 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages
304 */
305 readonly stages: Array<CfnPipeline.StageDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
306 /**
307 * The S3 bucket where artifacts for the pipeline are stored.
308 *
309 * > 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` .
310 *
311 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore
312 */
313 readonly artifactStore?: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
314 /**
315 * 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.
316 *
317 * > 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` .
318 *
319 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores
320 */
321 readonly artifactStores?: Array<CfnPipeline.ArtifactStoreMapProperty | cdk.IResolvable> | cdk.IResolvable;
322 /**
323 * Represents the input of a `DisableStageTransition` action.
324 *
325 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions
326 */
327 readonly disableInboundStageTransitions?: Array<CfnPipeline.StageTransitionProperty | cdk.IResolvable> | cdk.IResolvable;
328 /**
329 * The name of the pipeline.
330 *
331 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name
332 */
333 readonly name?: string;
334 /**
335 * Indicates whether to rerun the CodePipeline pipeline after you update it.
336 *
337 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate
338 */
339 readonly restartExecutionOnUpdate?: boolean | cdk.IResolvable;
340 /**
341 * Specifies the tags applied to the pipeline.
342 *
343 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags
344 */
345 readonly tags?: cdk.CfnTag[];
346}
347/**
348 * A CloudFormation `AWS::CodePipeline::Pipeline`
349 *
350 * 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* .
351 *
352 * @cloudformationResource AWS::CodePipeline::Pipeline
353 * @stability external
354 *
355 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
356 */
357export declare class CfnPipeline extends cdk.CfnResource implements cdk.IInspectable {
358 /**
359 * The CloudFormation resource type name for this resource class.
360 */
361 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodePipeline::Pipeline";
362 /**
363 * A factory method that creates a new instance of this class from an object
364 * containing the CloudFormation properties of this resource.
365 * Used in the @aws-cdk/cloudformation-include module.
366 *
367 * @internal
368 */
369 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnPipeline;
370 /**
371 * The version of the pipeline.
372 *
373 * > A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
374 * @cloudformationAttribute Version
375 */
376 readonly attrVersion: string;
377 /**
378 * 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` .
379 *
380 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-rolearn
381 */
382 roleArn: string;
383 /**
384 * Represents information about a stage and its definition.
385 *
386 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-stages
387 */
388 stages: Array<CfnPipeline.StageDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
389 /**
390 * The S3 bucket where artifacts for the pipeline are stored.
391 *
392 * > 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` .
393 *
394 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstore
395 */
396 artifactStore: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable | undefined;
397 /**
398 * 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.
399 *
400 * > 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` .
401 *
402 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-artifactstores
403 */
404 artifactStores: Array<CfnPipeline.ArtifactStoreMapProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
405 /**
406 * Represents the input of a `DisableStageTransition` action.
407 *
408 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-disableinboundstagetransitions
409 */
410 disableInboundStageTransitions: Array<CfnPipeline.StageTransitionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
411 /**
412 * The name of the pipeline.
413 *
414 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-name
415 */
416 name: string | undefined;
417 /**
418 * Indicates whether to rerun the CodePipeline pipeline after you update it.
419 *
420 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-restartexecutiononupdate
421 */
422 restartExecutionOnUpdate: boolean | cdk.IResolvable | undefined;
423 /**
424 * Specifies the tags applied to the pipeline.
425 *
426 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#cfn-codepipeline-pipeline-tags
427 */
428 readonly tags: cdk.TagManager;
429 /**
430 * Create a new `AWS::CodePipeline::Pipeline`.
431 *
432 * @param scope - scope in which this resource is defined
433 * @param id - scoped id of the resource
434 * @param props - resource properties
435 */
436 constructor(scope: cdk.Construct, id: string, props: CfnPipelineProps);
437 /**
438 * Examines the CloudFormation resource and discloses attributes.
439 *
440 * @param inspector - tree inspector to collect and process attributes
441 *
442 */
443 inspect(inspector: cdk.TreeInspector): void;
444 protected get cfnProperties(): {
445 [key: string]: any;
446 };
447 protected renderProperties(props: {
448 [key: string]: any;
449 }): {
450 [key: string]: any;
451 };
452}
453export declare namespace CfnPipeline {
454 /**
455 * Represents information about an action declaration.
456 *
457 * @struct
458 * @stability external
459 *
460 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html
461 */
462 interface ActionDeclarationProperty {
463 /**
464 * Specifies the action type and the provider of the action.
465 *
466 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid
467 */
468 readonly actionTypeId: CfnPipeline.ActionTypeIdProperty | cdk.IResolvable;
469 /**
470 * 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* .
471 *
472 * The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
473 *
474 * *JSON:*
475 *
476 * `"Configuration" : { Key : Value },`
477 *
478 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-configuration
479 */
480 readonly configuration?: any | cdk.IResolvable;
481 /**
482 * The name or ID of the artifact consumed by the action, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide* .
483 *
484 * > 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* .
485 *
486 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts
487 */
488 readonly inputArtifacts?: Array<CfnPipeline.InputArtifactProperty | cdk.IResolvable> | cdk.IResolvable;
489 /**
490 * The action declaration's name.
491 *
492 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-name
493 */
494 readonly name: string;
495 /**
496 * The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
497 *
498 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-actiondeclaration-namespace
499 */
500 readonly namespace?: string;
501 /**
502 * The name or ID of the result of the action declaration, such as a test or build artifact. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide* .
503 *
504 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts
505 */
506 readonly outputArtifacts?: Array<CfnPipeline.OutputArtifactProperty | cdk.IResolvable> | cdk.IResolvable;
507 /**
508 * The action declaration's AWS Region, such as us-east-1.
509 *
510 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-region
511 */
512 readonly region?: string;
513 /**
514 * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
515 *
516 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-rolearn
517 */
518 readonly roleArn?: string;
519 /**
520 * The order in which actions are run.
521 *
522 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions.html#cfn-codepipeline-pipeline-stages-actions-runorder
523 */
524 readonly runOrder?: number;
525 }
526}
527export declare namespace CfnPipeline {
528 /**
529 * Represents information about an action type.
530 *
531 * @struct
532 * @stability external
533 *
534 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html
535 */
536 interface ActionTypeIdProperty {
537 /**
538 * 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.
539 *
540 * - `Source`
541 * - `Build`
542 * - `Test`
543 * - `Deploy`
544 * - `Invoke`
545 * - `Approval`
546 *
547 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-category
548 */
549 readonly category: string;
550 /**
551 * 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) .
552 *
553 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-owner
554 */
555 readonly owner: string;
556 /**
557 * 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) .
558 *
559 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-provider
560 */
561 readonly provider: string;
562 /**
563 * A string that describes the action version.
564 *
565 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html#cfn-codepipeline-pipeline-stages-actions-actiontypeid-version
566 */
567 readonly version: string;
568 }
569}
570export declare namespace CfnPipeline {
571 /**
572 * The S3 bucket where artifacts for the pipeline are stored.
573 *
574 * > 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` .
575 *
576 * @struct
577 * @stability external
578 *
579 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html
580 */
581 interface ArtifactStoreProperty {
582 /**
583 * 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) .
584 *
585 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey
586 */
587 readonly encryptionKey?: CfnPipeline.EncryptionKeyProperty | cdk.IResolvable;
588 /**
589 * 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.
590 *
591 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-location
592 */
593 readonly location: string;
594 /**
595 * The type of the artifact store, such as S3.
596 *
597 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html#cfn-codepipeline-pipeline-artifactstore-type
598 */
599 readonly type: string;
600 }
601}
602export declare namespace CfnPipeline {
603 /**
604 * 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.
605 *
606 * > 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` .
607 *
608 * @struct
609 * @stability external
610 *
611 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html
612 */
613 interface ArtifactStoreMapProperty {
614 /**
615 * Represents information about the S3 bucket where artifacts are stored for the pipeline.
616 *
617 * > 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` .
618 *
619 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-artifactstore
620 */
621 readonly artifactStore: CfnPipeline.ArtifactStoreProperty | cdk.IResolvable;
622 /**
623 * The action declaration's AWS Region, such as us-east-1.
624 *
625 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstoremap.html#cfn-codepipeline-pipeline-artifactstoremap-region
626 */
627 readonly region: string;
628 }
629}
630export declare namespace CfnPipeline {
631 /**
632 * Reserved for future use.
633 *
634 * @struct
635 * @stability external
636 *
637 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html
638 */
639 interface BlockerDeclarationProperty {
640 /**
641 * Reserved for future use.
642 *
643 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-name
644 */
645 readonly name: string;
646 /**
647 * Reserved for future use.
648 *
649 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-blockers.html#cfn-codepipeline-pipeline-stages-blockers-type
650 */
651 readonly type: string;
652 }
653}
654export declare namespace CfnPipeline {
655 /**
656 * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
657 *
658 * `EncryptionKey` is a property of the [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) property type.
659 *
660 * @struct
661 * @stability external
662 *
663 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html
664 */
665 interface EncryptionKeyProperty {
666 /**
667 * 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.
668 *
669 * > 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. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).
670 *
671 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-id
672 */
673 readonly id: string;
674 /**
675 * The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
676 *
677 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore-encryptionkey.html#cfn-codepipeline-pipeline-artifactstore-encryptionkey-type
678 */
679 readonly type: string;
680 }
681}
682export declare namespace CfnPipeline {
683 /**
684 * Represents information about an artifact to be worked on, such as a test or build artifact.
685 *
686 * @struct
687 * @stability external
688 *
689 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html
690 */
691 interface InputArtifactProperty {
692 /**
693 * The name of the artifact to be worked on (for example, "My App").
694 *
695 * Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
696 *
697 * 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.
698 *
699 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html#cfn-codepipeline-pipeline-stages-actions-inputartifacts-name
700 */
701 readonly name: string;
702 }
703}
704export declare namespace CfnPipeline {
705 /**
706 * Represents information about the output of an action.
707 *
708 * @struct
709 * @stability external
710 *
711 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html
712 */
713 interface OutputArtifactProperty {
714 /**
715 * The name of the output of an artifact, such as "My App".
716 *
717 * 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.
718 *
719 * Output artifact names must be unique within a pipeline.
720 *
721 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html#cfn-codepipeline-pipeline-stages-actions-outputartifacts-name
722 */
723 readonly name: string;
724 }
725}
726export declare namespace CfnPipeline {
727 /**
728 * Represents information about a stage and its definition.
729 *
730 * @struct
731 * @stability external
732 *
733 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html
734 */
735 interface StageDeclarationProperty {
736 /**
737 * The actions included in a stage.
738 *
739 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-actions
740 */
741 readonly actions: Array<CfnPipeline.ActionDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
742 /**
743 * Reserved for future use.
744 *
745 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-blockers
746 */
747 readonly blockers?: Array<CfnPipeline.BlockerDeclarationProperty | cdk.IResolvable> | cdk.IResolvable;
748 /**
749 * The name of the stage.
750 *
751 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages.html#cfn-codepipeline-pipeline-stages-name
752 */
753 readonly name: string;
754 }
755}
756export declare namespace CfnPipeline {
757 /**
758 * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
759 *
760 * @struct
761 * @stability external
762 *
763 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html
764 */
765 interface StageTransitionProperty {
766 /**
767 * 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.
768 *
769 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-reason
770 */
771 readonly reason: string;
772 /**
773 * The name of the stage where you want to disable the inbound or outbound transition of artifacts.
774 *
775 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-disableinboundstagetransitions.html#cfn-codepipeline-pipeline-disableinboundstagetransitions-stagename
776 */
777 readonly stageName: string;
778 }
779}
780/**
781 * Properties for defining a `CfnWebhook`
782 *
783 * @struct
784 * @stability external
785 *
786 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html
787 */
788export interface CfnWebhookProps {
789 /**
790 * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
791 *
792 * - 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.
793 * - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
794 * - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
795 *
796 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication
797 */
798 readonly authentication: string;
799 /**
800 * 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.
801 *
802 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration
803 */
804 readonly authenticationConfiguration: CfnWebhook.WebhookAuthConfigurationProperty | cdk.IResolvable;
805 /**
806 * 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.
807 *
808 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters
809 */
810 readonly filters: Array<CfnWebhook.WebhookFilterRuleProperty | cdk.IResolvable> | cdk.IResolvable;
811 /**
812 * 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.
813 *
814 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction
815 */
816 readonly targetAction: string;
817 /**
818 * The name of the pipeline you want to connect to the webhook.
819 *
820 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline
821 */
822 readonly targetPipeline: string;
823 /**
824 * The version number of the pipeline to be connected to the trigger request.
825 *
826 * Required: Yes
827 *
828 * Type: Integer
829 *
830 * Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
831 *
832 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion
833 */
834 readonly targetPipelineVersion: number;
835 /**
836 * The name of the webhook.
837 *
838 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name
839 */
840 readonly name?: string;
841 /**
842 * Configures a connection between the webhook that was created and the external tool with events to be detected.
843 *
844 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty
845 */
846 readonly registerWithThirdParty?: boolean | cdk.IResolvable;
847}
848/**
849 * A CloudFormation `AWS::CodePipeline::Webhook`
850 *
851 * 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 [Migrate polling pipelines to use event-based change detection](https://docs.aws.amazon.com/codepipeline/latest/userguide/update-change-detection.html) in the *AWS CodePipeline User Guide* .
852 *
853 * 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) .
854 *
855 * > 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.
856 *
857 * @cloudformationResource AWS::CodePipeline::Webhook
858 * @stability external
859 *
860 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html
861 */
862export declare class CfnWebhook extends cdk.CfnResource implements cdk.IInspectable {
863 /**
864 * The CloudFormation resource type name for this resource class.
865 */
866 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodePipeline::Webhook";
867 /**
868 * A factory method that creates a new instance of this class from an object
869 * containing the CloudFormation properties of this resource.
870 * Used in the @aws-cdk/cloudformation-include module.
871 *
872 * @internal
873 */
874 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnWebhook;
875 /**
876 * The webhook URL generated by AWS CodePipeline , such as `https://eu-central-1.webhooks.aws/trigger123456` .
877 * @cloudformationAttribute Url
878 */
879 readonly attrUrl: string;
880 /**
881 * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
882 *
883 * - 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.
884 * - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
885 * - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
886 *
887 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication
888 */
889 authentication: string;
890 /**
891 * 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.
892 *
893 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration
894 */
895 authenticationConfiguration: CfnWebhook.WebhookAuthConfigurationProperty | cdk.IResolvable;
896 /**
897 * 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.
898 *
899 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters
900 */
901 filters: Array<CfnWebhook.WebhookFilterRuleProperty | cdk.IResolvable> | cdk.IResolvable;
902 /**
903 * 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.
904 *
905 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction
906 */
907 targetAction: string;
908 /**
909 * The name of the pipeline you want to connect to the webhook.
910 *
911 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline
912 */
913 targetPipeline: string;
914 /**
915 * The version number of the pipeline to be connected to the trigger request.
916 *
917 * Required: Yes
918 *
919 * Type: Integer
920 *
921 * Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
922 *
923 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion
924 */
925 targetPipelineVersion: number;
926 /**
927 * The name of the webhook.
928 *
929 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name
930 */
931 name: string | undefined;
932 /**
933 * Configures a connection between the webhook that was created and the external tool with events to be detected.
934 *
935 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty
936 */
937 registerWithThirdParty: boolean | cdk.IResolvable | undefined;
938 /**
939 * Create a new `AWS::CodePipeline::Webhook`.
940 *
941 * @param scope - scope in which this resource is defined
942 * @param id - scoped id of the resource
943 * @param props - resource properties
944 */
945 constructor(scope: cdk.Construct, id: string, props: CfnWebhookProps);
946 /**
947 * Examines the CloudFormation resource and discloses attributes.
948 *
949 * @param inspector - tree inspector to collect and process attributes
950 *
951 */
952 inspect(inspector: cdk.TreeInspector): void;
953 protected get cfnProperties(): {
954 [key: string]: any;
955 };
956 protected renderProperties(props: {
957 [key: string]: any;
958 }): {
959 [key: string]: any;
960 };
961}
962export declare namespace CfnWebhook {
963 /**
964 * The authentication applied to incoming webhook trigger requests.
965 *
966 * @struct
967 * @stability external
968 *
969 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html
970 */
971 interface WebhookAuthConfigurationProperty {
972 /**
973 * 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.
974 *
975 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-allowediprange
976 */
977 readonly allowedIpRange?: string;
978 /**
979 * The property used to configure GitHub authentication. For GITHUB_HMAC, only the `SecretToken` property must be set.
980 *
981 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookauthconfiguration.html#cfn-codepipeline-webhook-webhookauthconfiguration-secrettoken
982 */
983 readonly secretToken?: string;
984 }
985}
986export declare namespace CfnWebhook {
987 /**
988 * The event criteria that specify when a webhook notification is sent to your URL.
989 *
990 * @struct
991 * @stability external
992 *
993 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html
994 */
995 interface WebhookFilterRuleProperty {
996 /**
997 * 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.
998 *
999 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-jsonpath
1000 */
1001 readonly jsonPath: string;
1002 /**
1003 * 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) .
1004 *
1005 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-webhook-webhookfilterrule.html#cfn-codepipeline-webhook-webhookfilterrule-matchequals
1006 */
1007 readonly matchEquals?: string;
1008 }
1009}