aws-cdk-lib 2.73.0__py3-none-any.whl → 2.76.0__py3-none-any.whl

aws_cdk/pipelines/__init__.py

@@ -48,7 +48,6 @@ To use the CodePipeline engine, define a `CodePipeline` construct.  The followin
 example creates a CodePipeline that deploys an application from GitHub:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # The stacks for our app are minimally defined here.  The internals of these
 # stacks aren't important, except that DatabaseStack exposes an attribute
 # "table" for a database table it defines, and ComputeStack accepts a reference
@@ -166,7 +165,6 @@ To make the development more convenient, the self-mutation feature can be turned
 off temporarily, by passing `selfMutation: false` property, example:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # Modern API
 modern_pipeline = pipelines.CodePipeline(self, "Pipeline",
     self_mutation=False,
@@ -208,7 +206,6 @@ commands required will depend on the programming language you are using. For a
 typical NPM-based project, the synth will look like this:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 # the repository source
 
@@ -227,7 +224,6 @@ CDK project lives in a subdirectory, be sure to adjust the
 `primaryOutputDirectory` to match:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 # the repository source
 
@@ -257,7 +253,6 @@ look like in a number of different situations.
 For Yarn, the install commands are different:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 # the repository source
 
@@ -274,7 +269,6 @@ For Python projects, remember to install the CDK CLI globally (as
 there is no `package.json` to automatically install it for you):
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 # the repository source
 
@@ -293,7 +287,6 @@ and the Maven compilation step is automatically executed for you
 as you run `cdk synth`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 # the repository source
 
@@ -325,7 +318,6 @@ To avoid this, put your build instructions in a separate script, for example
 `build.sh`, and call that script from the build `commands` array:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer
 
 
@@ -355,7 +347,6 @@ You will first use the AWS Console to authenticate to the source control
 provider, and then use the connection ARN in your pipeline definition:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipelines.CodePipelineSource.connection("org/repo", "branch",
     connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
 )
@@ -370,7 +361,6 @@ you can change the name. The token should have the **repo** and **admin:repo_hoo
 scopes.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipelines.CodePipelineSource.git_hub("org/repo", "branch",
     # This is optional
     authentication=cdk.SecretValue.secrets_manager("my-token")
@@ -384,7 +374,6 @@ that the CodeCommit repository and then use `CodePipelineSource.codeCommit`
 to reference it:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 repository = codecommit.Repository.from_repository_name(self, "Repository", "my-repository")
 pipelines.CodePipelineSource.code_commit(repository, "main")
 ```
@@ -395,7 +384,6 @@ You can use a zip file in S3 as the source of the pipeline. The pipeline will be
 triggered every time the file in S3 is changed:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 bucket = s3.Bucket.from_bucket_name(self, "Bucket", "my-bucket")
 pipelines.CodePipelineSource.s3(bucket, "my/source.zip")
 ```
@@ -406,7 +394,6 @@ You can use a Docker image in ECR as the source of the pipeline. The pipeline wi
 triggered every time an image is pushed to ECR:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 repository = ecr.Repository(self, "Repository")
 pipelines.CodePipelineSource.ecr(repository)
 ```
@@ -419,7 +406,6 @@ output file set can be used as an input, such as a `CodePipelineSource`, but
 also other `ShellStep`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 prebuild = pipelines.ShellStep("Prebuild",
     input=pipelines.CodePipelineSource.git_hub("myorg/repo1", "main"),
     primary_output_directory="./build",
@@ -446,7 +432,6 @@ more CDK `Stages` which will be deployed to their target environments. To do
 so, call `pipeline.addStage()` on the Stage object:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 
 # Do this as many times as necessary with any account and region
@@ -481,7 +466,6 @@ deployed in sequence. For example, the following will deploy two copies of your
 application to `eu-west-1` and `eu-central-1` in parallel:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 
 europe_wave = pipeline.add_wave("Europe")
@@ -510,7 +494,6 @@ You may also wish to enable automatic key rotation for the created KMS key.
 Example:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipeline = pipelines.CodePipeline(self, "Pipeline",
     # Encrypt artifacts, required for cross-account deployments
     cross_account_keys=True,
@@ -535,7 +518,6 @@ are not retryable and creation of the change set costs time.
 The creation of change sets can be switched off by setting `useChangeSets: false`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # synth: pipelines.ShellStep
 
 
@@ -564,7 +546,6 @@ a manual approval in the form of a `ManualApprovalStep` added to the pipeline. B
 pass in order to promote from the `PreProd` to the `Prod` environment:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 
 preprod = MyApplicationStage(self, "PreProd")
@@ -587,7 +568,6 @@ pipeline.add_stage(prod,
 You can also specify steps to be executed at the stack level. To achieve this, you can specify the stack and step via the `stackSteps` property:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 class MyStacksStage(Stage):
 
@@ -614,7 +594,6 @@ If you specify multiple steps, they will execute in parallel by default. You can
 to if you wish to specify an order. To add a dependency, call `step.addStepDependency()`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 first_step = pipelines.ManualApprovalStep("A")
 second_step = pipelines.ManualApprovalStep("B")
 second_step.add_step_dependency(first_step)
@@ -624,7 +603,6 @@ For convenience, `Step.sequence()` will take an array of steps and dependencies
 so that the whole list executes in order:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # Step A will depend on step B and step B will depend on step C
 ordered_steps = pipelines.Step.sequence([
     pipelines.ManualApprovalStep("A"),
@@ -643,7 +621,6 @@ To use Stack Outputs, expose the `CfnOutput` object you're interested in, and
 pass it to `envFromCfnOutputs` of the `ShellStep`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 class MyOutputStage(Stage):
 
@@ -678,7 +655,6 @@ Here's an example that captures an additional output directory in the synth
 step and runs tests from there:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # synth: pipelines.ShellStep
 
 stage = MyApplicationStage(self, "MyApplication")
@@ -704,7 +680,6 @@ generated, use a `CodeBuildStep` instead of a `ShellStep`. This class has a numb
 of properties that allow you to customize various aspects of the projects:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # vpc: ec2.Vpc
 # my_security_group: ec2.SecurityGroup
 
@@ -758,7 +733,6 @@ or just for the synth, asset publishing, and self-mutation projects by passing `
 `assetPublishingCodeBuildDefaults`, or `selfMutationCodeBuildDefaults`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # vpc: ec2.Vpc
 # my_security_group: ec2.SecurityGroup
 
@@ -810,7 +784,6 @@ doesn't have a matching class yet, you can define your own step class that exten
 Here's an example that adds a Jenkins step:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 @jsii.implements(pipelines.ICodePipelineActionFactory)
 class MyJenkinsStep(pipelines.Step):
     def __init__(self, provider, input):
@@ -847,25 +820,26 @@ class MyJenkinsStep(pipelines.Step):
 Another example, adding a lambda step referencing outputs from a stack:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 @jsii.implements(pipelines.ICodePipelineActionFactory)
 class MyLambdaStep(pipelines.Step):
 
-    def __init__(self):
-        pass
-    super().__init__("MyLambdaStep")
-    self.stack_output_reference = pipelines.StackOutputReference.from_cfn_output(stack_output)produce_action(stage, codepipeline.IStage, options, pipelines.ProduceActionOptions)pipelines.CodePipelineActionFactoryResult
-
-    stage.add_action(cpactions.LambdaInvokeAction(
-        action_name=options.action_name,
-        run_order=options.run_order,
-        # Map the reference to the variable name the CDK has generated for you.
-        user_parameters={"stack_output": options.stack_outputs_map.to_code_pipeline(self.stack_output_reference)},
-        lambda_=self.function
-    ))
-
-    return {"run_orders_consumed": 1}getconsumed_stack_outputs()pipelines.StackOutputReference[]
-    return [self.stack_output_reference]
+    def __init__(self, fn, stack_output):
+        super().__init__("MyLambdaStep")
+        self.stack_output_reference = pipelines.StackOutputReference.from_cfn_output(stack_output)
+
+    def produce_action(self, stage, *, scope, actionName, runOrder, variablesNamespace=None, artifacts, fallbackArtifact=None, pipeline, codeBuildDefaults=None, beforeSelfMutation=None, stackOutputsMap):
+
+        stage.add_action(cpactions.LambdaInvokeAction(
+            action_name=action_name,
+            run_order=run_order,
+            # Map the reference to the variable name the CDK has generated for you.
+            user_parameters={"stack_output": stack_outputs_map.to_code_pipeline(self.stack_output_reference)},
+            lambda_=self.fn
+        ))
+
+        return pipelines.CodePipelineActionFactoryResult(run_orders_consumed=1)public get consumedStackOutputs(): pipelines.StackOutputReference[] {
+        return [this.stackOutputReference];
+      }
 ```
 
 ### Using an existing AWS Codepipeline
@@ -881,7 +855,6 @@ Here's an example of passing in an existing pipeline and using a *source* that's
 in the pipeline:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # code_pipeline: codepipeline.Pipeline
 
 
@@ -900,7 +873,6 @@ If your existing pipeline already provides a synth step, pass the existing
 artifact in place of the `synth` step:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # code_pipeline: codepipeline.Pipeline
 
 
@@ -945,7 +917,6 @@ stacks the pipeline is deploying), for example by the use of `LinuxBuildImage.fr
 you need to pass `dockerEnabledForSelfMutation: true` to the pipeline. For example:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipeline = pipelines.CodePipeline(self, "Pipeline",
     synth=pipelines.ShellStep("Synth",
         input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -985,7 +956,6 @@ if you add a construct like `@aws-cdk/aws-lambda-nodejs`), you need to pass
 `dockerEnabledForSynth: true` to the pipeline. For example:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipeline = pipelines.CodePipeline(self, "Pipeline",
     synth=pipelines.ShellStep("Synth",
         input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -1011,7 +981,6 @@ any of the application stages — require authentication, either due to being in
 different environment (e.g., ECR repo) or to avoid throttling (e.g., DockerHub).
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 docker_hub_secret = secretsmanager.Secret.from_secret_complete_arn(self, "DHSecret", "arn:aws:...")
 custom_reg_secret = secretsmanager.Secret.from_secret_complete_arn(self, "CRSecret", "arn:aws:...")
 repo1 = ecr.Repository.from_repository_arn(self, "Repo", "arn:aws:ecr:eu-west-1:0123456789012:repository/Repo1")
@@ -1045,7 +1014,6 @@ the **Synth**, **Self-Update**, and **Asset Publishing** actions within the
 *pipeline. The scope of the credentials can be limited via the `DockerCredentialUsage` option.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 docker_hub_secret = secretsmanager.Secret.from_secret_complete_arn(self, "DHSecret", "arn:aws:...")
 # Only the image asset publishing actions will be granted read access to the secret.
 creds = pipelines.DockerCredential.docker_hub(docker_hub_secret, usages=[pipelines.DockerCredentialUsage.ASSET_PUBLISHING])
@@ -1225,7 +1193,6 @@ give the synth CodeBuild execution role permissions to assume the bootstrapped
 lookup roles. As an example, doing so would look like this:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 pipelines.CodePipeline(self, "Pipeline",
     synth=pipelines.CodeBuildStep("Synth",
         input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -1308,7 +1275,6 @@ Pipeline
 You can insert the security check by using a `ConfirmPermissionsBroadening` step:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 
 stage = MyApplicationStage(self, "MyApplication")
@@ -1324,7 +1290,6 @@ create an SNS Topic, subscribe your own email address, and pass it in as
 as the `notificationTopic` property:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # pipeline: pipelines.CodePipeline
 
 topic = sns.Topic(self, "SecurityChangesTopic")
@@ -1450,7 +1415,6 @@ that bundles asset using tools run via Docker, like `aws-lambda-nodejs`, `aws-la
 Make sure you set the `privileged` environment variable to `true` in the synth definition:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 source_artifact = codepipeline.Artifact()
 cloud_assembly_artifact = codepipeline.Artifact()
 pipeline = pipelines.CdkPipeline(self, "MyPipeline",
@@ -1531,7 +1495,6 @@ build projects get out-of-sync with the generated templates. To fix this, make s
 `selfMutating` property is set to `true`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 cloud_assembly_artifact = codepipeline.Artifact()
 pipeline = pipelines.CdkPipeline(self, "MyPipeline",
     self_mutating=True,
@@ -1569,7 +1532,6 @@ $ env CDK_NEW_BOOTSTRAP=1 npx cdk bootstrap \
   See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html for more info.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 Stack(self, "MyStack",
     # Update this qualifier to match the one used above.
     synthesizer=cdk.DefaultStackSynthesizer(
@@ -1644,7 +1606,6 @@ your tooling and by adding the `CDK_DOCKER` environment variable to your
 build environment.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer # the repository source
 # synth_commands: List[str] # Commands to synthesize your app
 # install_commands: List[str]
@@ -1659,21 +1620,21 @@ pipeline = pipelines.CodePipeline(self, "Pipeline",
 
     # Configure CodeBuild to use a drop-in Docker replacement.
     code_build_defaults=pipelines.CodeBuildOptions(
-        build_environment=codebuild.BuildEnvironment(
-            partial_build_spec=Codebuild.BuildSpec.from_object(
-                phases={
-                    "install": {
-                        # Add the shell commands to install your drop-in Docker
-                        # replacement to the CodeBuild enviromment.
-                        "commands": install_commands
-                    }
+        partial_build_spec=codebuild.BuildSpec.from_object({
+            "phases": {
+                "install": {
+                    # Add the shell commands to install your drop-in Docker
+                    # replacement to the CodeBuild enviromment.
+                    "commands": install_commands
                 }
-            ),
+            }
+        }),
+        build_environment=codebuild.BuildEnvironment(
             environment_variables={
                 # Instruct the AWS CDK to use `drop-in-replacement` instead of
                 # `docker` when building / publishing docker images.
                 # e.g., `drop-in-replacement build . -f path/to/Dockerfile`
-                "CDK_DOCKER": "drop-in-replacement"
+                "CDK_DOCKER": codebuild.BuildEnvironmentVariable(value="drop-in-replacement")
             }
         )
     )
@@ -1688,7 +1649,6 @@ an `ENV` in your `Dockerfile` or by providing the environment variable in the
 pipeline as shown below.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # source: pipelines.IFileSetProducer # the repository source
 # synth_commands: List[str]
 # Commands to synthesize your app
@@ -1710,7 +1670,7 @@ pipeline = pipelines.CodePipeline(self, "Pipeline",
                 # If you haven't provided an `ENV` in your Dockerfile that overrides
                 # `CDK_DOCKER`, then you must provide the name of the command that
                 # the AWS CDK should run instead of `docker` here.
-                "CDK_DOCKER": "drop-in-replacement"
+                "CDK_DOCKER": codebuild.BuildEnvironmentVariable(value="drop-in-replacement")
             }
         )
     )
@@ -1818,7 +1778,6 @@ class AddStageOpts:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # pipeline: pipelines.CodePipeline
             
             preprod = MyApplicationStage(self, "PreProd")
@@ -1976,7 +1935,6 @@ class CodeBuildOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # source: pipelines.IFileSetProducer # the repository source
             # synth_commands: List[str] # Commands to synthesize your app
             # install_commands: List[str]
@@ -1991,21 +1949,21 @@ class CodeBuildOptions:
             
                 # Configure CodeBuild to use a drop-in Docker replacement.
                 code_build_defaults=pipelines.CodeBuildOptions(
-                    build_environment=codebuild.BuildEnvironment(
-                        partial_build_spec=Codebuild.BuildSpec.from_object(
-                            phases={
-                                "install": {
-                                    # Add the shell commands to install your drop-in Docker
-                                    # replacement to the CodeBuild enviromment.
-                                    "commands": install_commands
-                                }
+                    partial_build_spec=codebuild.BuildSpec.from_object({
+                        "phases": {
+                            "install": {
+                                # Add the shell commands to install your drop-in Docker
+                                # replacement to the CodeBuild enviromment.
+                                "commands": install_commands
                             }
-                        ),
+                        }
+                    }),
+                    build_environment=codebuild.BuildEnvironment(
                         environment_variables={
                             # Instruct the AWS CDK to use `drop-in-replacement` instead of
                             # `docker` when building / publishing docker images.
                             # e.g., `drop-in-replacement build . -f path/to/Dockerfile`
-                            "CDK_DOCKER": "drop-in-replacement"
+                            "CDK_DOCKER": codebuild.BuildEnvironmentVariable(value="drop-in-replacement")
                         }
                     )
                 )
@@ -2354,6 +2312,7 @@ class CodePipelineActionFactoryResult:
     jsii_struct_bases=[],
     name_mapping={
         "synth": "synth",
+        "artifact_bucket": "artifactBucket",
         "asset_publishing_code_build_defaults": "assetPublishingCodeBuildDefaults",
         "cli_version": "cliVersion",
         "code_build_defaults": "codeBuildDefaults",
@@ -2378,6 +2337,7 @@ class CodePipelineProps:
         self,
         *,
         synth: "IFileSetProducer",
+        artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
         asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         cli_version: typing.Optional[builtins.str] = None,
         code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -2399,6 +2359,7 @@ class CodePipelineProps:
         '''Properties for a ``CodePipeline``.
 
         :param synth: The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be the ``cdk.out`` directory generated by the ``cdk synth`` command. If you use a ``ShellStep`` here and you don't configure an output directory, the output directory will automatically be assumed to be ``cdk.out``.
+        :param artifact_bucket: An existing S3 Bucket to use for storing the pipeline's artifact. Default: - A new S3 bucket will be created.
         :param asset_publishing_code_build_defaults: Additional customizations to apply to the asset publishing CodeBuild projects. Default: - Only ``codeBuildDefaults`` are applied
         :param cli_version: CDK CLI version to use in self-mutation and asset publishing steps. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
         :param code_build_defaults: Customize the CodeBuild projects created for this pipeline. Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0
@@ -2421,7 +2382,6 @@ class CodePipelineProps:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # code_pipeline: codepipeline.Pipeline
             
             
@@ -2446,6 +2406,7 @@ class CodePipelineProps:
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__c46bc21ca63efb27c935c31017ebbc8c85b3b93ae1798e54892dd3eae41d99aa)
             check_type(argname="argument synth", value=synth, expected_type=type_hints["synth"])
+            check_type(argname="argument artifact_bucket", value=artifact_bucket, expected_type=type_hints["artifact_bucket"])
             check_type(argname="argument asset_publishing_code_build_defaults", value=asset_publishing_code_build_defaults, expected_type=type_hints["asset_publishing_code_build_defaults"])
             check_type(argname="argument cli_version", value=cli_version, expected_type=type_hints["cli_version"])
             check_type(argname="argument code_build_defaults", value=code_build_defaults, expected_type=type_hints["code_build_defaults"])
@@ -2466,6 +2427,8 @@ class CodePipelineProps:
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "synth": synth,
         }
+        if artifact_bucket is not None:
+            self._values["artifact_bucket"] = artifact_bucket
         if asset_publishing_code_build_defaults is not None:
             self._values["asset_publishing_code_build_defaults"] = asset_publishing_code_build_defaults
         if cli_version is not None:
@@ -2515,6 +2478,15 @@ class CodePipelineProps:
         assert result is not None, "Required property 'synth' is missing"
         return typing.cast("IFileSetProducer", result)
 
+    @builtins.property
+    def artifact_bucket(self) -> typing.Optional[_IBucket_42e086fd]:
+        '''An existing S3 Bucket to use for storing the pipeline's artifact.
+
+        :default: - A new S3 bucket will be created.
+        '''
+        result = self._values.get("artifact_bucket")
+        return typing.cast(typing.Optional[_IBucket_42e086fd], result)
+
     @builtins.property
     def asset_publishing_code_build_defaults(self) -> typing.Optional[CodeBuildOptions]:
         '''Additional customizations to apply to the asset publishing CodeBuild projects.
@@ -2785,7 +2757,6 @@ class ConnectionSourceOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             pipeline = pipelines.CodePipeline(self, "Pipeline",
                 synth=pipelines.ShellStep("Synth",
                     input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -2837,7 +2808,6 @@ class ConnectionSourceOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             "arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh"
         '''
         result = self._values.get("connection_arn")
@@ -2905,7 +2875,6 @@ class DockerCredential(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         docker_hub_secret = secretsmanager.Secret.from_secret_complete_arn(self, "DHSecret", "arn:aws:...")
         custom_reg_secret = secretsmanager.Secret.from_secret_complete_arn(self, "CRSecret", "arn:aws:...")
         repo1 = ecr.Repository.from_repository_arn(self, "Repo", "arn:aws:ecr:eu-west-1:0123456789012:repository/Repo1")
@@ -3087,7 +3056,6 @@ class DockerCredentialUsage(enum.Enum):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         docker_hub_secret = secretsmanager.Secret.from_secret_complete_arn(self, "DHSecret", "arn:aws:...")
         # Only the image asset publishing actions will be granted read access to the secret.
         creds = pipelines.DockerCredential.docker_hub(docker_hub_secret, usages=[pipelines.DockerCredentialUsage.ASSET_PUBLISHING])
@@ -3122,7 +3090,6 @@ class ECRSourceOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # repository: ecr.IRepository
             
             pipelines.CodePipelineSource.ecr(repository,
@@ -3272,7 +3239,6 @@ class ExternalDockerCredentialOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             docker_hub_secret = secretsmanager.Secret.from_secret_complete_arn(self, "DHSecret", "arn:aws:...")
             # Only the image asset publishing actions will be granted read access to the secret.
             creds = pipelines.DockerCredential.docker_hub(docker_hub_secret, usages=[pipelines.DockerCredentialUsage.ASSET_PUBLISHING])
@@ -3430,7 +3396,6 @@ class GitHubSourceOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             pipelines.CodePipelineSource.git_hub("org/repo", "branch",
                 # This is optional
                 authentication=cdk.SecretValue.secrets_manager("my-token")
@@ -3464,7 +3429,6 @@ class GitHubSourceOptions:
 
         It is recommended to use a Secrets Manager ``Secret`` to obtain the token::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            oauth = cdk.SecretValue.secrets_manager("my-github-token")
 
         The GitHub Personal Access Token should have these scopes:
@@ -3729,7 +3693,6 @@ class PermissionsBroadeningCheckProps:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # pipeline: pipelines.CodePipeline
             
             stage = MyApplicationStage(self, "MyApplication")
@@ -3873,7 +3836,6 @@ class PipelineBase(
 
         Example::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            # pipeline: pipelines.CodePipeline
 
 
@@ -4391,7 +4353,6 @@ class ShellStepProps:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # code_pipeline: codepipeline.Pipeline
             
             
@@ -4451,7 +4412,6 @@ class ShellStepProps:
         the main input and an additional input side-by-side with the
         following configuration::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            script = pipelines.ShellStep("MainScript",
                commands=["npm ci", "npm run build", "npx cdk synth"],
                input=pipelines.CodePipelineSource.git_hub("org/source1", "main"),
@@ -5091,25 +5051,26 @@ class StackOutputReference(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         @jsii.implements(pipelines.ICodePipelineActionFactory)
         class MyLambdaStep(pipelines.Step):
         
-            def __init__(self):
-                pass
-            super().__init__("MyLambdaStep")
-            self.stack_output_reference = pipelines.StackOutputReference.from_cfn_output(stack_output)produce_action(stage, codepipeline.IStage, options, pipelines.ProduceActionOptions)pipelines.CodePipelineActionFactoryResult
+            def __init__(self, fn, stack_output):
+                super().__init__("MyLambdaStep")
+                self.stack_output_reference = pipelines.StackOutputReference.from_cfn_output(stack_output)
         
-            stage.add_action(cpactions.LambdaInvokeAction(
-                action_name=options.action_name,
-                run_order=options.run_order,
-                # Map the reference to the variable name the CDK has generated for you.
-                user_parameters={"stack_output": options.stack_outputs_map.to_code_pipeline(self.stack_output_reference)},
-                lambda_=self.function
-            ))
+            def produce_action(self, stage, *, scope, actionName, runOrder, variablesNamespace=None, artifacts, fallbackArtifact=None, pipeline, codeBuildDefaults=None, beforeSelfMutation=None, stackOutputsMap):
         
-            return {"run_orders_consumed": 1}getconsumed_stack_outputs()pipelines.StackOutputReference[]
-            return [self.stack_output_reference]
+                stage.add_action(cpactions.LambdaInvokeAction(
+                    action_name=action_name,
+                    run_order=run_order,
+                    # Map the reference to the variable name the CDK has generated for you.
+                    user_parameters={"stack_output": stack_outputs_map.to_code_pipeline(self.stack_output_reference)},
+                    lambda_=self.fn
+                ))
+        
+                return pipelines.CodePipelineActionFactoryResult(run_orders_consumed=1)public get consumedStackOutputs(): pipelines.StackOutputReference[] {
+                return [this.stackOutputReference];
+              }
     '''
 
     @jsii.member(jsii_name="fromCfnOutput")
@@ -5554,13 +5515,37 @@ class Step(metaclass=jsii.JSIIAbstractClass, jsii_type="aws-cdk-lib.pipelines.St
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
-        # Step A will depend on step B and step B will depend on step C
-        ordered_steps = pipelines.Step.sequence([
-            pipelines.ManualApprovalStep("A"),
-            pipelines.ManualApprovalStep("B"),
-            pipelines.ManualApprovalStep("C")
-        ])
+        @jsii.implements(pipelines.ICodePipelineActionFactory)
+        class MyJenkinsStep(pipelines.Step):
+            def __init__(self, provider, input):
+                super().__init__("MyJenkinsStep")
+        
+                # This is necessary if your step accepts parameters, like environment variables,
+                # that may contain outputs from other steps. It doesn't matter what the
+                # structure is, as long as it contains the values that may contain outputs.
+                self.discover_referenced_outputs({
+                    "env": {}
+                })
+        
+            def produce_action(self, stage, *, scope, actionName, runOrder, variablesNamespace=None, artifacts, fallbackArtifact=None, pipeline, codeBuildDefaults=None, beforeSelfMutation=None, stackOutputsMap):
+        
+                # This is where you control what type of Action gets added to the
+                # CodePipeline
+                stage.add_action(cpactions.JenkinsAction(
+                    # Copy 'actionName' and 'runOrder' from the options
+                    action_name=action_name,
+                    run_order=run_order,
+        
+                    # Jenkins-specific configuration
+                    type=cpactions.JenkinsActionType.TEST,
+                    jenkins_provider=self.provider,
+                    project_name="MyJenkinsProject",
+        
+                    # Translate the FileSet into a codepipeline.Artifact
+                    inputs=[artifacts.to_code_pipeline(self.input)]
+                ))
+        
+                return pipelines.CodePipelineActionFactoryResult(run_orders_consumed=1)
     '''
 
     def __init__(self, id: builtins.str) -> None:
@@ -5702,7 +5687,6 @@ class Wave(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.pipelines.Wave"):
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # pipeline: pipelines.CodePipeline
         
         europe_wave = pipeline.add_wave("Europe")
@@ -5827,7 +5811,6 @@ class WaveOptions:
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             pipeline = pipelines.CodePipeline(self, "Pipeline",
                 synth=pipelines.ShellStep("Synth",
                     input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -6042,7 +6025,6 @@ class CodeBuildStepProps(ShellStepProps):
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             pipeline = pipelines.CodePipeline(self, "Pipeline",
                 synth=pipelines.ShellStep("Synth",
                     input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -6156,7 +6138,6 @@ class CodeBuildStepProps(ShellStepProps):
         the main input and an additional input side-by-side with the
         following configuration::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            script = pipelines.ShellStep("MainScript",
                commands=["npm ci", "npm run build", "npx cdk synth"],
                input=pipelines.CodePipelineSource.git_hub("org/source1", "main"),
@@ -6398,7 +6379,6 @@ class CodePipeline(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # code_pipeline: codepipeline.Pipeline
         
         
@@ -6419,6 +6399,7 @@ class CodePipeline(
         id: builtins.str,
         *,
         synth: IFileSetProducer,
+        artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
         asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         cli_version: typing.Optional[builtins.str] = None,
         code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -6441,6 +6422,7 @@ class CodePipeline(
         :param scope: -
         :param id: -
         :param synth: The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be the ``cdk.out`` directory generated by the ``cdk synth`` command. If you use a ``ShellStep`` here and you don't configure an output directory, the output directory will automatically be assumed to be ``cdk.out``.
+        :param artifact_bucket: An existing S3 Bucket to use for storing the pipeline's artifact. Default: - A new S3 bucket will be created.
         :param asset_publishing_code_build_defaults: Additional customizations to apply to the asset publishing CodeBuild projects. Default: - Only ``codeBuildDefaults`` are applied
         :param cli_version: CDK CLI version to use in self-mutation and asset publishing steps. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
         :param code_build_defaults: Customize the CodeBuild projects created for this pipeline. Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_6_0
@@ -6465,6 +6447,7 @@ class CodePipeline(
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
         props = CodePipelineProps(
             synth=synth,
+            artifact_bucket=artifact_bucket,
             asset_publishing_code_build_defaults=asset_publishing_code_build_defaults,
             cli_version=cli_version,
             code_build_defaults=code_build_defaults,
@@ -6541,7 +6524,6 @@ class CodePipelineSource(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # Access the CommitId of a GitHub source in the synth
         source = pipelines.CodePipelineSource.git_hub("owner/repo", "main")
         
@@ -6591,7 +6573,6 @@ class CodePipelineSource(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # repository: codecommit.IRepository
             
             pipelines.CodePipelineSource.code_commit(repository, "main")
@@ -6634,7 +6615,6 @@ class CodePipelineSource(
 
         Example::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            pipelines.CodePipelineSource.connection("owner/repo", "main",
                connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
            )
@@ -6681,7 +6661,6 @@ class CodePipelineSource(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # repository: ecr.IRepository
             
             pipelines.CodePipelineSource.ecr(repository,
@@ -6714,7 +6693,6 @@ class CodePipelineSource(
 
         Pass in the owner and repository in a single string, like this::
 
-           # Example automatically generated from non-compiling source. May contain errors.
            pipelines.CodePipelineSource.git_hub("owner/repo", "main")
 
         Authentication will be done by a secret called ``github-token`` in AWS
@@ -6768,7 +6746,6 @@ class CodePipelineSource(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # bucket: s3.Bucket
             
             pipelines.CodePipelineSource.s3(bucket, "path/to/file.zip")
@@ -6862,7 +6839,6 @@ class CodePipelineSource(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # Access the CommitId of a GitHub source in the synth
             source = pipelines.CodePipelineSource.git_hub("owner/repo", "main")
             
@@ -6935,7 +6911,6 @@ class ConfirmPermissionsBroadening(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # pipeline: pipelines.CodePipeline
         
         stage = MyApplicationStage(self, "MyApplication")
@@ -7027,7 +7002,6 @@ class FileSet(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.pipelines.FileSet"
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         @jsii.implements(pipelines.ICodePipelineActionFactory)
         class MyJenkinsStep(pipelines.Step):
             def __init__(self, provider, input):
@@ -7133,7 +7107,6 @@ class ManualApprovalStep(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # pipeline: pipelines.CodePipeline
         
         preprod = MyApplicationStage(self, "PreProd")
@@ -7194,7 +7167,6 @@ class ShellStep(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # code_pipeline: codepipeline.Pipeline
         
         
@@ -7357,7 +7329,6 @@ class CodeBuildStep(
     ``buildspec.yml`` in your repository, extract them to a script
     (say, ``build.sh``) and invoke that script as part of the build::
 
-       # Example automatically generated from non-compiling source. May contain errors.
        pipelines.CodeBuildStep("Synth",
            commands=["./build.sh"]
        )
@@ -7366,7 +7337,6 @@ class CodeBuildStep(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         pipeline = pipelines.CodePipeline(self, "Pipeline",
             synth=pipelines.ShellStep("Synth",
                 input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
@@ -7479,7 +7449,6 @@ class CodeBuildStep(
 
         Example::
 
-            # Example automatically generated from non-compiling source. May contain errors.
             # Access the output of one CodeBuildStep in another CodeBuildStep
             # pipeline: pipelines.CodePipeline
             
@@ -7650,7 +7619,6 @@ class CodePipelineFileSet(
 
     Example::
 
-        # Example automatically generated from non-compiling source. May contain errors.
         # code_pipeline: codepipeline.Pipeline
         
         
@@ -7779,6 +7747,7 @@ def _typecheckingstub__9624d5022538eedc98a469f78de5916fac4ee13ff0d2f5f9a5e9d447c
 def _typecheckingstub__c46bc21ca63efb27c935c31017ebbc8c85b3b93ae1798e54892dd3eae41d99aa(
     *,
     synth: IFileSetProducer,
+    artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
     asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     cli_version: typing.Optional[builtins.str] = None,
     code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
@@ -8238,6 +8207,7 @@ def _typecheckingstub__7b4b4a0bcbd5fab3e4b78aa07ff9504469ae96c16799604ca3345bcb9
     id: builtins.str,
     *,
     synth: IFileSetProducer,
+    artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
     asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     cli_version: typing.Optional[builtins.str] = None,
     code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,