software.amazon.awscdk.services.codepipeline.actions

Interface JenkinsProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JenkinsProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.543Z")
 @Stability(value=Stable)
public interface JenkinsProviderProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 JenkinsProvider jenkinsProvider = JenkinsProvider.Builder.create(this, "JenkinsProvider")
         .providerName("MyJenkinsProvider")
         .serverUrl("http://my-jenkins.com:8080")
         .version("2")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JenkinsProviderProps.Builder A builder for JenkinsProviderProps
static class	JenkinsProviderProps.Jsii$Proxy An implementation for JenkinsProviderProps

Method Summary

Modifier and Type	Method and Description
static JenkinsProviderProps.Builder	builder()
default Boolean	getForBuild() Whether to immediately register a Jenkins Provider for the build category.
default Boolean	getForTest() Whether to immediately register a Jenkins Provider for the test category.
String	getProviderName() The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.
String	getServerUrl() The base URL of your Jenkins server.
default String	getVersion() The version of your provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getProviderName

@Stability(value=Stable)
 @NotNull
String getProviderName()

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";
 

getServerUrl

@Stability(value=Stable)
 @NotNull
String getServerUrl()

The base URL of your Jenkins server.

Example:

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

getForBuild

@Stability(value=Stable)
 @Nullable
default Boolean getForBuild()

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

getForTest

@Stability(value=Stable)
 @Nullable
default Boolean getForTest()

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

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

The version of your provider.

Default: '1'

builder

@Stability(value=Stable)
static JenkinsProviderProps.Builder builder()

Returns:

a JenkinsProviderProps.Builder of JenkinsProviderProps