Package software.amazon.awscdk.pipelines

Class CodePipelineProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.pipelines.CodePipelineProps.Jsii$Proxy
All Implemented Interfaces:
CodePipelineProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CodePipelineProps
@Stability(Stable) @Internal public static final class CodePipelineProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CodePipelineProps
An implementation for CodePipelineProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CodePipelineProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CodePipelineProps.Builder.

  • Method Details

    • getSynth

      public final IFileSetProducer getSynth()
      Description copied from interface: CodePipelineProps
      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.

      Specified by:
      getSynth in interface CodePipelineProps

    • getArtifactBucket

      public final IBucket getArtifactBucket()
      Description copied from interface: CodePipelineProps
      An existing S3 Bucket to use for storing the pipeline's artifact.

      Default: - A new S3 bucket will be created.

      Specified by:
      getArtifactBucket in interface CodePipelineProps

    • getAssetPublishingCodeBuildDefaults

      public final CodeBuildOptions getAssetPublishingCodeBuildDefaults()
      Description copied from interface: CodePipelineProps
      Additional customizations to apply to the asset publishing CodeBuild projects.

      Default: - Only `codeBuildDefaults` are applied

      Specified by:
      getAssetPublishingCodeBuildDefaults in interface CodePipelineProps

    • getCdkAssetsCliVersion

      public final String getCdkAssetsCliVersion()
      Description copied from interface: CodePipelineProps
      CDK CLI version to use in asset publishing steps.

      If you want to lock the cdk-assets 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.

      Default: - Latest version

      Specified by:
      getCdkAssetsCliVersion in interface CodePipelineProps
      See Also:

    • getCliVersion

      public final String getCliVersion()
      Description copied from interface: CodePipelineProps
      CDK CLI version to use in self-mutation step.

      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

      Specified by:
      getCliVersion in interface CodePipelineProps

    • getCodeBuildDefaults

      public final CodeBuildOptions getCodeBuildDefaults()
      Description copied from interface: CodePipelineProps
      Customize the CodeBuild projects created for this pipeline.

      Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_7_0

      Specified by:
      getCodeBuildDefaults in interface CodePipelineProps

    • getCodePipeline

      public final Pipeline getCodePipeline()
      Description copied from interface: CodePipelineProps
      An existing Pipeline to be reused and built upon.

      [disable-awslint:ref-via-interface]

      Default: - a new underlying pipeline is created.

      Specified by:
      getCodePipeline in interface CodePipelineProps

    • getCrossAccountKeys

      public final Boolean getCrossAccountKeys()
      Description copied from interface: CodePipelineProps
      Create KMS keys for the artifact buckets, allowing cross-account deployments.

      The artifact buckets have to be encrypted to support deploying CDK apps to another account, so if you want to do that or want to have your artifact buckets encrypted, be sure to set this value to true.

      Be aware there is a cost associated with maintaining the KMS keys.

      Default: false

      Specified by:
      getCrossAccountKeys in interface CodePipelineProps

    • getCrossRegionReplicationBuckets

      public final Map<String,IBucket> getCrossRegionReplicationBuckets()
      Description copied from interface: CodePipelineProps
      A map of region to S3 bucket name used for cross-region CodePipeline.

      For every Action that you specify targeting a different region than the Pipeline itself, if you don't provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region. Passed directly through to the

      invalid reference 
      cp.Pipeline
      .

      Default: - no cross region replication buckets.

      Specified by:
      getCrossRegionReplicationBuckets in interface CodePipelineProps

    • getDockerCredentials

      public final List<DockerCredential> getDockerCredentials()
      Description copied from interface: CodePipelineProps
      A list of credentials used to authenticate to Docker registries.

      Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.

      Default: []

      Specified by:
      getDockerCredentials in interface CodePipelineProps

    • getDockerEnabledForSelfMutation

      public final Boolean getDockerEnabledForSelfMutation()
      Description copied from interface: CodePipelineProps
      Enable Docker for the self-mutate step.

      Set this to true if the pipeline itself uses Docker container assets (for example, if you use LinuxBuildImage.fromAsset() as the build image of a CodeBuild step in the pipeline).

      You do not need to set it if you build Docker image assets in the application Stages and Stacks that are deployed by this pipeline.

      Configures privileged mode for the self-mutation CodeBuild action.

      If you are about to turn this on in an already-deployed Pipeline, set the value to true first, commit and allow the pipeline to self-update, and only then use the Docker asset in the pipeline.

      Default: false

      Specified by:
      getDockerEnabledForSelfMutation in interface CodePipelineProps

    • getDockerEnabledForSynth

      public final Boolean getDockerEnabledForSynth()
      Description copied from interface: CodePipelineProps
      Enable Docker for the 'synth' step.

      Set this to true if you are using file assets that require "bundling" anywhere in your application (meaning an asset compilation step will be run with the tools provided by a Docker image), both for the Pipeline stack as well as the application stacks.

      A common way to use bundling assets in your application is by using the aws-cdk-lib/aws-lambda-nodejs library.

      Configures privileged mode for the synth CodeBuild action.

      If you are about to turn this on in an already-deployed Pipeline, set the value to true first, commit and allow the pipeline to self-update, and only then use the bundled asset.

      Default: false

      Specified by:
      getDockerEnabledForSynth in interface CodePipelineProps

    • getEnableKeyRotation

      public final Boolean getEnableKeyRotation()
      Description copied from interface: CodePipelineProps
      Enable KMS key rotation for the generated KMS keys.

      By default KMS key rotation is disabled, but will add additional costs when enabled.

      Default: - false (key rotation is disabled)

      Specified by:
      getEnableKeyRotation in interface CodePipelineProps

    • getPipelineName

      public final String getPipelineName()
      Description copied from interface: CodePipelineProps
      The name of the CodePipeline pipeline.

      Default: - Automatically generated

      Specified by:
      getPipelineName in interface CodePipelineProps

    • getPipelineType

      public final PipelineType getPipelineType()
      Description copied from interface: CodePipelineProps
      Type of the pipeline.

      Default: - PipelineType.V2 if the feature flag `CODEPIPELINE_DEFAULT_PIPELINE_TYPE_TO_V2` is true, PipelineType.V1 otherwise

      Specified by:
      getPipelineType in interface CodePipelineProps
      See Also:

    • getPublishAssetsInParallel

      public final Boolean getPublishAssetsInParallel()
      Description copied from interface: CodePipelineProps
      Publish assets in multiple CodeBuild projects.

      If set to false, use one Project per type to publish all assets.

      Publishing in parallel improves concurrency and may reduce publishing latency, but may also increase overall provisioning time of the CodeBuild projects.

      Experiment and see what value works best for you.

      Default: true

      Specified by:
      getPublishAssetsInParallel in interface CodePipelineProps

    • getReuseCrossRegionSupportStacks

      public final Boolean getReuseCrossRegionSupportStacks()
      Description copied from interface: CodePipelineProps
      Reuse the same cross region support stack for all pipelines in the App.

      Default: - true (Use the same support stack for all pipelines in App)

      Specified by:
      getReuseCrossRegionSupportStacks in interface CodePipelineProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CodePipelineProps
      The IAM role to be assumed by this Pipeline.

      Default: - A new role is created

      Specified by:
      getRole in interface CodePipelineProps

    • getSelfMutation

      public final Boolean getSelfMutation()
      Description copied from interface: CodePipelineProps
      Whether the pipeline will update itself.

      This needs to be set to true to allow the pipeline to reconfigure itself when assets or stages are being added to it, and true is the recommended setting.

      You can temporarily set this to false while you are iterating on the pipeline itself and prefer to deploy changes using cdk deploy.

      Default: true

      Specified by:
      getSelfMutation in interface CodePipelineProps

    • getSelfMutationCodeBuildDefaults

      public final CodeBuildOptions getSelfMutationCodeBuildDefaults()
      Description copied from interface: CodePipelineProps
      Additional customizations to apply to the self mutation CodeBuild projects.

      Default: - Only `codeBuildDefaults` are applied

      Specified by:
      getSelfMutationCodeBuildDefaults in interface CodePipelineProps

    • getSynthCodeBuildDefaults

      public final CodeBuildOptions getSynthCodeBuildDefaults()
      Description copied from interface: CodePipelineProps
      Additional customizations to apply to the synthesize CodeBuild projects.

      Default: - Only `codeBuildDefaults` are applied

      Specified by:
      getSynthCodeBuildDefaults in interface CodePipelineProps

    • getUseChangeSets

      public final Boolean getUseChangeSets()
      Description copied from interface: CodePipelineProps
      Deploy every stack by creating a change set and executing it.

      When enabled, creates a "Prepare" and "Execute" action for each stack. Disable to deploy the stack in one pipeline action.

      Default: true

      Specified by:
      getUseChangeSets in interface CodePipelineProps

    • getUsePipelineRoleForActions

      public final Boolean getUsePipelineRoleForActions()
      Description copied from interface: CodePipelineProps
      Use pipeline service role for actions if no action role configured.

      Default: - false

      Specified by:
      getUsePipelineRoleForActions in interface CodePipelineProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object