Class JenkinsProvider.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.JenkinsProvider.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<JenkinsProvider>
Enclosing class:
JenkinsProvider

@Stability(Stable) public static final class JenkinsProvider.Builder extends Object implements software.amazon.jsii.Builder<JenkinsProvider>
A fluent builder for JenkinsProvider.
  • Method Details

    • create

      @Stability(Stable) public static JenkinsProvider.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of JenkinsProvider.Builder.
    • providerName

      @Stability(Stable) public JenkinsProvider.Builder providerName(String providerName)
      The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

      Example:

       "MyJenkinsProvider";
       

      Parameters:
      providerName - The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project. This parameter is required.
      Returns:
      this
    • serverUrl

      @Stability(Stable) public JenkinsProvider.Builder serverUrl(String serverUrl)
      The base URL of your Jenkins server.

      Example:

       "http://myjenkins.com:8080";
       

      Parameters:
      serverUrl - The base URL of your Jenkins server. This parameter is required.
      Returns:
      this
    • forBuild

      @Stability(Stable) public JenkinsProvider.Builder forBuild(Boolean forBuild)
      Whether to immediately register a Jenkins Provider for the build category.

      The Provider will always be registered if you create a JenkinsAction.

      Default: false

      Parameters:
      forBuild - Whether to immediately register a Jenkins Provider for the build category. This parameter is required.
      Returns:
      this
    • forTest

      @Stability(Stable) public JenkinsProvider.Builder forTest(Boolean forTest)
      Whether to immediately register a Jenkins Provider for the test category.

      The Provider will always be registered if you create a JenkinsTestAction.

      Default: false

      Parameters:
      forTest - Whether to immediately register a Jenkins Provider for the test category. This parameter is required.
      Returns:
      this
    • version

      @Stability(Stable) public JenkinsProvider.Builder version(String version)
      The version of your provider.

      Default: '1'

      Parameters:
      version - The version of your provider. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public JenkinsProvider build()
      Specified by:
      build in interface software.amazon.jsii.Builder<JenkinsProvider>
      Returns:
      a newly built instance of JenkinsProvider.