Class: AWSCDK::CodePipelineActions::JenkinsProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
code_pipeline_actions/jenkins_provider_props.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider_name:, server_url:, for_build: nil, for_test: nil, version: nil) ⇒ JenkinsProviderProps

Returns a new instance of JenkinsProviderProps.

Parameters:

  • provider_name (String) —

    The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

  • server_url (String) —

    The base URL of your Jenkins server.

  • for_build (Boolean, nil) (defaults to: nil) —

    Whether to immediately register a Jenkins Provider for the build category.

  • for_test (Boolean, nil) (defaults to: nil) —

    Whether to immediately register a Jenkins Provider for the test category.

  • version (String, nil) (defaults to: nil) —

    The version of your provider.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 11

def initialize(provider_name:, server_url:, for_build: nil, for_test: nil, version: nil)
  @provider_name = provider_name
  Jsii::Type.check_type(@provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "providerName")
  @server_url = server_url
  Jsii::Type.check_type(@server_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverUrl")
  @for_build = for_build
  Jsii::Type.check_type(@for_build, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "forBuild") unless @for_build.nil?
  @for_test = for_test
  Jsii::Type.check_type(@for_test, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "forTest") unless @for_test.nil?
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#for_build ⇒ Boolean? (readonly)

Note:

Default: false

Whether to immediately register a Jenkins Provider for the build category.

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

Returns:

  • (Boolean, nil) 


42
43
44
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 42

def for_build
  @for_build
end

#for_test ⇒ Boolean? (readonly)

Note:

Default: false

Whether to immediately register a Jenkins Provider for the test category.

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

Returns:

  • (Boolean, nil) 


49
50
51
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 49

def for_test
  @for_test
end

#provider_name ⇒ String (readonly)

The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

Examples:

"MyJenkinsProvider"

Returns:

  • (String) 


29
30
31
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 29

def provider_name
  @provider_name
end

#server_url ⇒ String (readonly)

The base URL of your Jenkins server.

Examples:

"http://myjenkins.com:8080"

Returns:

  • (String) 


35
36
37
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 35

def server_url
  @server_url
end

#version ⇒ String? (readonly)

Note:

Default: '1'

The version of your provider.

Returns:

  • (String, nil) 


54
55
56
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 54

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 56

def self.jsii_properties
  {
    :provider_name => "providerName",
    :server_url => "serverUrl",
    :for_build => "forBuild",
    :for_test => "forTest",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'code_pipeline_actions/jenkins_provider_props.rb', line 66

def to_jsii
  result = {}
  result.merge!({
    "providerName" => @provider_name,
    "serverUrl" => @server_url,
    "forBuild" => @for_build,
    "forTest" => @for_test,
    "version" => @version,
  })
  result.compact
end