JenkinsProvider

class aws_cdk.aws_codepipeline_actions.JenkinsProvider(scope, id, *, provider_name, server_url, for_build=None, for_test=None, version=None)

Bases: aws_cdk.aws_codepipeline_actions.BaseJenkinsProvider

A class representing Jenkins providers.

See

#import

ExampleMetadata

infused

Example:

jenkins_provider = codepipeline_actions.JenkinsProvider(self, "JenkinsProvider",
    provider_name="MyJenkinsProvider",
    server_url="http://my-jenkins.com:8080",
    version="2"
)
Parameters

  • scope (Construct) –

  • id (str) –

  • provider_name (str) – The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

  • server_url (str) – The base URL of your Jenkins server.

  • for_build (Optional[bool]) – 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

  • for_test (Optional[bool]) – 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

  • version (Optional[str]) – The version of your provider. Default: ‘1’

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

provider_name
Return type

str

server_url
Return type

str

version
Return type

str

Static Methods

classmethod from_jenkins_provider_attributes(scope, id, *, provider_name, server_url, version=None)

Import a Jenkins provider registered either outside the CDK, or in a different CDK Stack.

Parameters

  • scope (Construct) – the parent Construct for the new provider.

  • id (str) – the identifier of the new provider Construct.

  • provider_name (str) – The name of the Jenkins provider that you set in the AWS CodePipeline plugin configuration of your Jenkins project.

  • server_url (str) – The base URL of your Jenkins server.

  • version (Optional[str]) – The version of your provider. Default: ‘1’

Return type

IJenkinsProvider

Returns

a new Construct representing a reference to an existing Jenkins provider

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool