software.amazon.awscdk.services.codepipeline.actions

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(value=Stable)
public static final class JenkinsProvider.Builder
extends Object
implements software.amazon.jsii.Builder<JenkinsProvider>

A fluent builder for JenkinsProvider.

Method Summary

Modifier and Type	Method and Description
JenkinsProvider	build()
static JenkinsProvider.Builder	create(software.constructs.Construct scope, String id)
JenkinsProvider.Builder	forBuild(Boolean forBuild) Whether to immediately register a Jenkins Provider for the build category.
JenkinsProvider.Builder	forTest(Boolean forTest) Whether to immediately register a Jenkins Provider for the test category.
JenkinsProvider.Builder	providerName(String providerName) The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.
JenkinsProvider.Builder	serverUrl(String serverUrl) The base URL of your Jenkins server.
JenkinsProvider.Builder	version(String version) The version of your provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=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(value=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:

 // Example automatically generated from non-compiling source. May contain errors.
 "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(value=Stable)
public JenkinsProvider.Builder serverUrl(String serverUrl)

The base URL of your Jenkins server.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "http://myjenkins.com:8080";
 

Parameters:

serverUrl - The base URL of your Jenkins server. This parameter is required.

Returns:

this

forBuild

@Stability(value=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 {@link JenkinsAction}.

Default: false

Parameters:

forBuild - Whether to immediately register a Jenkins Provider for the build category. This parameter is required.

Returns:

this

forTest

@Stability(value=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 {@link JenkinsTestAction}.

Default: false

Parameters:

forTest - Whether to immediately register a Jenkins Provider for the test category. This parameter is required.

Returns:

this

version

@Stability(value=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(value=Stable)
public JenkinsProvider build()

Specified by:

build in interface software.amazon.jsii.Builder<JenkinsProvider>