@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-codepipeline-pipeline.d.ts

@@ -0,0 +1,577 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CodePipelinePipeline = ResourceDefinitionWithAttributes<"AWS::CodePipeline::Pipeline", CodePipelinePipelineProps, CodePipelinePipelineAttribs>;
+/**
+ * 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 *CodePipeline User Guide* .
+ *
+ * For an example in YAML and JSON that contains the parameters in this reference, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html#aws-resource-codepipeline-pipeline--examples) .
+ */
+export type CodePipelinePipelineProps = {
+    /**
+     * The S3 bucket where artifacts for the pipeline are stored.
+     *
+     * > 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` .
+     */
+    ArtifactStore?: ArtifactStore | undefined;
+    /**
+     * 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.
+     *
+     * > 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` .
+     */
+    ArtifactStores?: ArtifactStoreMap[] | undefined;
+    /**
+     * Represents the input of a `DisableStageTransition` action.
+     */
+    DisableInboundStageTransitions?: StageTransition[] | undefined;
+    /**
+     * The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
+     * @default "SUPERSEDED"
+     */
+    ExecutionMode?: "QUEUED" | "SUPERSEDED" | "PARALLEL" | undefined;
+    /**
+     * The name of the pipeline.
+     */
+    Name?: string | undefined;
+    /**
+     * CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
+     *
+     * - V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
+     * - V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
+     *
+     * > Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.
+     *
+     * For information about pricing for CodePipeline, see [Pricing](https://docs.aws.amazon.com/codepipeline/pricing/) .
+     *
+     * For information about which type of pipeline to choose, see [What type of pipeline is right for me?](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types-planning.html) .
+     */
+    PipelineType?: "V1" | "V2" | undefined;
+    /**
+     * Indicates whether to rerun the CodePipeline pipeline after you update it.
+     */
+    RestartExecutionOnUpdate?: boolean | undefined;
+    /**
+     * 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` .
+     * @pattern arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*
+     */
+    RoleArn: string;
+    /**
+     * Represents information about a stage and its definition.
+     */
+    Stages: StageDeclaration[];
+    /**
+     * Specifies the tags applied to the pipeline.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
+     *
+     * > When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
+     */
+    Triggers?: PipelineTriggerDeclaration[] | undefined;
+    /**
+     * A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match `[A-Za-z0-9@\-_]+` .
+     */
+    Variables?: VariableDeclaration[] | undefined;
+};
+export type CodePipelinePipelineAttribs = {
+    /**
+     * The version of the pipeline.
+     *
+     * > A new pipeline is always assigned a version number of 1. This number increments when a pipeline is updated.
+     */
+    Version: string;
+};
+/**
+ * Represents information about an action declaration.
+ */
+export type ActionDeclaration = {
+    /**
+     * Specifies the action type and the provider of the action.
+     */
+    ActionTypeId: ActionTypeId;
+    /**
+     * The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
+     *
+     * > Using compute time for this action will incur separate charges in AWS CodeBuild .
+     */
+    Commands?: string[] | undefined;
+    /**
+     * 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* .
+     *
+     * The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
+     *
+     * *JSON:*
+     *
+     * `"Configuration" : { Key : Value },`
+     */
+    Configuration?: Record<string, unknown> | undefined;
+    /**
+     * The environment variables for the action.
+     */
+    EnvironmentVariables?: EnvironmentVariable[] | undefined;
+    /**
+     * 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* .
+     *
+     * > 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* .
+     */
+    InputArtifacts?: InputArtifact[] | undefined;
+    /**
+     * The action declaration's name.
+     */
+    Name: string;
+    /**
+     * The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
+     */
+    Namespace?: string | undefined;
+    /**
+     * 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* .
+     */
+    OutputArtifacts?: OutputArtifact[] | undefined;
+    /**
+     * The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
+     */
+    OutputVariables?: string[] | undefined;
+    /**
+     * The action declaration's AWS Region, such as us-east-1.
+     */
+    Region?: string | undefined;
+    /**
+     * The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
+     * @pattern arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*
+     */
+    RoleArn?: string | undefined;
+    /**
+     * The order in which actions are run.
+     */
+    RunOrder?: number | undefined;
+    /**
+     * A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in [Quotas for AWS CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html) . This attribute is available only to the manual approval ActionType.
+     */
+    TimeoutInMinutes?: number | undefined;
+};
+/**
+ * Represents information about an action type.
+ */
+export type ActionTypeId = {
+    /**
+     * 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.
+     *
+     * - `Source`
+     * - `Build`
+     * - `Test`
+     * - `Deploy`
+     * - `Invoke`
+     * - `Approval`
+     * - `Compute`
+     */
+    Category: "Source" | "Build" | "Test" | "Deploy" | "Invoke" | "Approval" | "Compute";
+    /**
+     * 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) .
+     */
+    Owner: string;
+    /**
+     * 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) .
+     */
+    Provider: string;
+    /**
+     * A string that describes the action version.
+     */
+    Version: string;
+};
+/**
+ * The S3 bucket where artifacts for the pipeline are stored.
+ *
+ * > 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` .
+ */
+export type ArtifactStore = {
+    /**
+     * 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) .
+     */
+    EncryptionKey?: EncryptionKey | undefined;
+    /**
+     * 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.
+     */
+    Location: string;
+    /**
+     * The type of the artifact store, such as S3.
+     */
+    Type: "S3";
+};
+/**
+ * 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.
+ *
+ * > 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` .
+ */
+export type ArtifactStoreMap = {
+    /**
+     * Represents information about the S3 bucket where artifacts are stored for the pipeline.
+     *
+     * > 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` .
+     */
+    ArtifactStore: ArtifactStore;
+    /**
+     * The action declaration's AWS Region, such as us-east-1.
+     */
+    Region: string;
+};
+/**
+ * The conditions for making checks for entry to a stage. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) .
+ */
+export type BeforeEntryConditions = {
+    /**
+     * The conditions that are configured as entry conditions.
+     */
+    Conditions?: Condition[] | undefined;
+};
+/**
+ * Reserved for future use.
+ */
+export type BlockerDeclaration = {
+    /**
+     * Reserved for future use.
+     */
+    Name: string;
+    /**
+     * Reserved for future use.
+     */
+    Type: "Schedule";
+};
+/**
+ * The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) .. For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html) .
+ */
+export type Condition = {
+    /**
+     * The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
+     */
+    Result?: string | undefined;
+    /**
+     * The rules that make up the condition.
+     */
+    Rules?: RuleDeclaration[] | undefined;
+};
+/**
+ * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service ( AWS KMS) key.
+ *
+ * `EncryptionKey` is a property of the [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) property type.
+ */
+export type EncryptionKey = {
+    /**
+     * 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.
+     *
+     * > 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).
+     */
+    Id: string;
+    /**
+     * The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
+     */
+    Type: string;
+};
+/**
+ * The environment variables for the action.
+ */
+export type EnvironmentVariable = {
+    /**
+     * The environment variable name in the key-value pair.
+     */
+    Name: string;
+    /**
+     * The type of the environment variable.
+     */
+    Type?: "PLAINTEXT" | "SECRETS_MANAGER" | undefined;
+    /**
+     * The environment variable value in the key-value pair.
+     */
+    Value: string;
+};
+/**
+ * The configuration that specifies the result, such as rollback, to occur upon stage failure. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) .
+ */
+export type FailureConditions = {
+    /**
+     * The conditions that are configured as failure conditions. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) .
+     */
+    Conditions?: Condition[] | undefined;
+    /**
+     * The specified result for when the failure conditions are met, such as rolling back the stage.
+     */
+    Result?: "ROLLBACK" | "RETRY" | undefined;
+    /**
+     * The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
+     */
+    RetryConfiguration?: {
+        /**
+         * The specified retry mode type for the given stage. FAILED_ACTIONS will retry only the failed actions. ALL_ACTIONS will retry both failed and successful
+         */
+        RetryMode?: "ALL_ACTIONS" | "FAILED_ACTIONS" | undefined;
+    } | undefined;
+};
+/**
+ * The Git repository branches specified as filter criteria to start the pipeline.
+ */
+export type GitBranchFilterCriteria = {
+    /**
+     * The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
+     */
+    Excludes?: string[] | undefined;
+    /**
+     * The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
+     */
+    Includes?: string[] | undefined;
+};
+/**
+ * A type of trigger configuration for Git-based source actions.
+ *
+ * > You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the `CodeStarSourceConnection` action type.
+ */
+export type GitConfiguration = {
+    /**
+     * The field where the repository event that will start the pipeline is specified as pull requests.
+     */
+    PullRequest?: GitPullRequestFilter[] | undefined;
+    /**
+     * The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.
+     */
+    Push?: GitPushFilter[] | undefined;
+    /**
+     * The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.
+     *
+     * > You can only specify one trigger configuration per source action.
+     */
+    SourceActionName: string;
+};
+/**
+ * The Git repository file paths specified as filter criteria to start the pipeline.
+ */
+export type GitFilePathFilterCriteria = {
+    /**
+     * The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
+     */
+    Excludes?: string[] | undefined;
+    /**
+     * The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
+     */
+    Includes?: string[] | undefined;
+};
+/**
+ * The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
+ *
+ * The following are valid values for the events for this filter:
+ *
+ * - CLOSED
+ * - OPEN
+ * - UPDATED
+ */
+export type GitPullRequestFilter = {
+    /**
+     * The field that specifies to filter on branches for the pull request trigger configuration.
+     */
+    Branches?: GitBranchFilterCriteria | undefined;
+    /**
+     * The field that specifies which pull request events to filter on (OPEN, UPDATED, CLOSED) for the trigger configuration.
+     */
+    Events?: string[] | undefined;
+    /**
+     * The field that specifies to filter on file paths for the pull request trigger configuration.
+     */
+    FilePaths?: GitFilePathFilterCriteria | undefined;
+};
+/**
+ * The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.
+ */
+export type GitPushFilter = {
+    /**
+     * The field that specifies to filter on branches for the push trigger configuration.
+     */
+    Branches?: GitBranchFilterCriteria | undefined;
+    /**
+     * The field that specifies to filter on file paths for the push trigger configuration.
+     */
+    FilePaths?: GitFilePathFilterCriteria | undefined;
+    /**
+     * The field that contains the details for the Git tags trigger configuration.
+     */
+    Tags?: GitTagFilterCriteria | undefined;
+};
+/**
+ * The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.
+ */
+export type GitTagFilterCriteria = {
+    /**
+     * The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.
+     */
+    Excludes?: string[] | undefined;
+    /**
+     * The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.
+     */
+    Includes?: string[] | undefined;
+};
+/**
+ * Represents information about an artifact to be worked on, such as a test or build artifact.
+ */
+export type InputArtifact = {
+    /**
+     * The name of the artifact to be worked on (for example, "My App").
+     *
+     * 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
+     *
+     * 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.
+     */
+    Name: string;
+};
+/**
+ * Represents information about the output of an action.
+ */
+export type OutputArtifact = {
+    /**
+     * The files that you want to associate with the output artifact that will be exported from the compute action.
+     */
+    Files?: string[] | undefined;
+    /**
+     * The name of the output of an artifact, such as "My App".
+     *
+     * 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.
+     *
+     * Output artifact names must be unique within a pipeline.
+     */
+    Name: string;
+};
+/**
+ * Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
+ *
+ * > This is only supported for the `CodeStarSourceConnection` action type. > When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
+ */
+export type PipelineTriggerDeclaration = {
+    /**
+     * Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.
+     */
+    GitConfiguration?: GitConfiguration | undefined;
+    /**
+     * The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
+     */
+    ProviderType: "CodeStarSourceConnection";
+};
+/**
+ * Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) . For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html) .
+ */
+export type RuleDeclaration = {
+    /**
+     * The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
+     *
+     * > Using compute time for this action will incur separate charges in AWS CodeBuild .
+     */
+    Commands?: string[] | undefined;
+    /**
+     * The action configuration fields for the rule.
+     */
+    Configuration?: Record<string, unknown> | undefined;
+    /**
+     * The input artifacts fields for the rule, such as specifying an input file for the rule.
+     */
+    InputArtifacts?: InputArtifact[] | undefined;
+    /**
+     * The name of the rule that is created for the condition, such as `VariableCheck` .
+     */
+    Name?: string | undefined;
+    /**
+     * The Region for the condition associated with the rule.
+     */
+    Region?: string | undefined;
+    /**
+     * The pipeline role ARN associated with the rule.
+     * @pattern arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*
+     */
+    RoleArn?: string | undefined;
+    /**
+     * The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
+     */
+    RuleTypeId?: RuleTypeId | undefined;
+};
+/**
+ * The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) . For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html) .
+ */
+export type RuleTypeId = {
+    /**
+     * A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is `Rule` .
+     */
+    Category?: string | undefined;
+    /**
+     * The creator of the rule being called. The valid value for the `Owner` field in the rule category is `AWS` .
+     */
+    Owner?: string | undefined;
+    /**
+     * The rule provider, such as the `DeploymentWindow` rule. For a list of rule provider names, see the rules listed in the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html) .
+     */
+    Provider?: string | undefined;
+    /**
+     * A string that describes the rule version.
+     */
+    Version?: string | undefined;
+};
+/**
+ * Represents information about a stage and its definition.
+ */
+export type StageDeclaration = {
+    /**
+     * The actions included in a stage.
+     */
+    Actions: ActionDeclaration[];
+    /**
+     * The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.
+     */
+    BeforeEntry?: BeforeEntryConditions | undefined;
+    /**
+     * Reserved for future use.
+     */
+    Blockers?: BlockerDeclaration[] | undefined;
+    /**
+     * The name of the stage.
+     */
+    Name: string;
+    /**
+     * The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
+     */
+    OnFailure?: FailureConditions | undefined;
+    /**
+     * The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.
+     */
+    OnSuccess?: SuccessConditions | undefined;
+};
+/**
+ * The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
+ */
+export type StageTransition = {
+    /**
+     * 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.
+     */
+    Reason: string;
+    /**
+     * The name of the stage where you want to disable the inbound or outbound transition of artifacts.
+     */
+    StageName: string;
+};
+/**
+ * The conditions for making checks that, if met, succeed a stage. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html) .
+ */
+export type SuccessConditions = {
+    /**
+     * The conditions that are success conditions.
+     */
+    Conditions?: Condition[] | undefined;
+};
+/**
+ * A variable declared at the pipeline level.
+ */
+export type VariableDeclaration = {
+    /**
+     * The value of a pipeline-level variable.
+     */
+    DefaultValue?: string | undefined;
+    /**
+     * The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.
+     */
+    Description?: string | undefined;
+    /**
+     * The name of a pipeline-level variable.
+     */
+    Name: string;
+};
+//# sourceMappingURL=aws-codepipeline-pipeline.d.ts.map

package/out/exports/resources.generated/aws-codepipeline-webhook.d.ts

@@ -0,0 +1,91 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CodePipelineWebhook = ResourceDefinitionWithAttributes<"AWS::CodePipeline::Webhook", CodePipelineWebhookProps, CodePipelineWebhookAttribs>;
+/**
+ * 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* .
+ *
+ * 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) .
+ *
+ * > 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.
+ */
+export type CodePipelineWebhookProps = {
+    /**
+     * Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
+     *
+     * > When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. > If a secret token was provided, it will be redacted in the response.
+     *
+     * - 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.
+     * - IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
+     * - UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
+     */
+    Authentication: string;
+    /**
+     * 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.
+     */
+    AuthenticationConfiguration: WebhookAuthConfiguration;
+    /**
+     * 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.
+     */
+    Filters: WebhookFilterRule[];
+    /**
+     * The name of the webhook.
+     */
+    Name?: string | undefined;
+    /**
+     * Configures a connection between the webhook that was created and the external tool with events to be detected.
+     */
+    RegisterWithThirdParty?: boolean | undefined;
+    /**
+     * 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.
+     */
+    TargetAction: string;
+    /**
+     * The name of the pipeline you want to connect to the webhook.
+     */
+    TargetPipeline: string;
+    /**
+     * The version number of the pipeline to be connected to the trigger request.
+     *
+     * Required: Yes
+     *
+     * Type: Integer
+     *
+     * Update requires: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
+     */
+    TargetPipelineVersion: number;
+};
+export type CodePipelineWebhookAttribs = {
+    Id: string;
+    /**
+     * The webhook URL generated by AWS CodePipeline , such as `https://eu-central-1.webhooks.aws/trigger123456` .
+     */
+    Url: string;
+};
+/**
+ * The authentication applied to incoming webhook trigger requests.
+ */
+export type WebhookAuthConfiguration = {
+    /**
+     * 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.
+     */
+    AllowedIPRange?: string | undefined;
+    /**
+     * The property used to configure GitHub authentication. For GITHUB_HMAC, only the `SecretToken` property must be set.
+     *
+     * > When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities. > If a secret token was provided, it will be redacted in the response.
+     */
+    SecretToken?: string | undefined;
+};
+/**
+ * The event criteria that specify when a webhook notification is sent to your URL.
+ */
+export type WebhookFilterRule = {
+    /**
+     * 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.
+     */
+    JsonPath: string;
+    /**
+     * 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) .
+     */
+    MatchEquals?: string | undefined;
+};
+//# sourceMappingURL=aws-codepipeline-webhook.d.ts.map