Class: AWSCDK::CodePipelineActions::JenkinsProviderAttributes

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

Overview

Properties for importing an existing Jenkins provider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider_name:, server_url:, version: nil) ⇒ JenkinsProviderAttributes

Returns a new instance of JenkinsProviderAttributes.

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.

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

    The version of your provider.



10
11
12
13
14
15
16
17
 
# File 'code_pipeline_actions/jenkins_provider_attributes.rb', line 10

def initialize(provider_name:, server_url:, 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")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#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) 


24
25
26
 
# File 'code_pipeline_actions/jenkins_provider_attributes.rb', line 24

def provider_name
  @provider_name
end

#server_url ⇒ String (readonly)

The base URL of your Jenkins server.

Examples:

"http://myjenkins.com:8080"

Returns:

  • (String) 


30
31
32
 
# File 'code_pipeline_actions/jenkins_provider_attributes.rb', line 30

def server_url
  @server_url
end

#version ⇒ String? (readonly)

Note:

Default: '1'

The version of your provider.

Returns:

  • (String, nil) 


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

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
43
 
# File 'code_pipeline_actions/jenkins_provider_attributes.rb', line 37

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

Instance Method Details

#to_jsii ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'code_pipeline_actions/jenkins_provider_attributes.rb', line 45

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