codepipeline

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.codepipeline.Pipeline(resource_name, opts=None, artifact_store=None, name=None, role_arn=None, stages=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a CodePipeline.

NOTE on ``codepipeline.Pipeline``: - the GITHUB_TOKEN environment variable must be set if the GitHub provider is specified.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • artifact_store (pulumi.Input[dict]) – An artifact_store block. Artifact stores are documented below.

* `stage` (Minimum of at least two `stage` blocks is required) A stage block. Stages are documented below.
Parameters
  • name (pulumi.Input[str]) – The name of the pipeline.

  • role_arn (pulumi.Input[str]) – A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The artifact_store object supports the following:

  • encryption_key (pulumi.Input[dict])

    • id (pulumi.Input[str]) - The codepipeline ID.

    • type (pulumi.Input[str])

  • location (pulumi.Input[str])

  • type (pulumi.Input[str])

The stages object supports the following:

  • actions (pulumi.Input[list])

    • category (pulumi.Input[str])

    • configuration (pulumi.Input[dict])

    • inputArtifacts (pulumi.Input[list])

    • name (pulumi.Input[str]) - The name of the pipeline.

    • outputArtifacts (pulumi.Input[list])

    • owner (pulumi.Input[str])

    • provider (pulumi.Input[str])

    • role_arn (pulumi.Input[str]) - A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf.

    • runOrder (pulumi.Input[float])

    • version (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the pipeline.

arn = None

The codepipeline ARN.

artifact_store = None

An artifact_store block. Artifact stores are documented below.

  • stage (Minimum of at least two stage blocks is required) A stage block. Stages are documented below.

    • encryption_key (dict)

      • id (str) - The codepipeline ID.

      • type (str)

    • location (str)

    • type (str)

name = None

The name of the pipeline.

role_arn = None

A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, artifact_store=None, name=None, role_arn=None, stages=None, tags=None)

Get an existing Pipeline resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The codepipeline ARN.

  • artifact_store (pulumi.Input[dict]) – An artifact_store block. Artifact stores are documented below.

* `stage` (Minimum of at least two `stage` blocks is required) A stage block. Stages are documented below.
Parameters
  • name (pulumi.Input[str]) – The name of the pipeline.

  • role_arn (pulumi.Input[str]) – A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The artifact_store object supports the following:

  • encryption_key (pulumi.Input[dict])

    • id (pulumi.Input[str]) - The codepipeline ID.

    • type (pulumi.Input[str])

  • location (pulumi.Input[str])

  • type (pulumi.Input[str])

The stages object supports the following:

  • actions (pulumi.Input[list])

    • category (pulumi.Input[str])

    • configuration (pulumi.Input[dict])

    • inputArtifacts (pulumi.Input[list])

    • name (pulumi.Input[str]) - The name of the pipeline.

    • outputArtifacts (pulumi.Input[list])

    • owner (pulumi.Input[str])

    • provider (pulumi.Input[str])

    • role_arn (pulumi.Input[str]) - A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf.

    • runOrder (pulumi.Input[float])

    • version (pulumi.Input[str])

  • name (pulumi.Input[str]) - The name of the pipeline.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.codepipeline.Webhook(resource_name, opts=None, authentication=None, authentication_configuration=None, filters=None, name=None, tags=None, target_action=None, target_pipeline=None, __props__=None, __name__=None, __opts__=None)

Provides a CodePipeline Webhook.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • authentication (pulumi.Input[str]) – The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED.

  • authentication_configuration (pulumi.Input[dict]) – An auth block. Required for IP and GITHUB_HMAC. Auth blocks are documented below.

  • filters (pulumi.Input[list]) – One or more filter blocks. Filter blocks are documented below.

  • name (pulumi.Input[str]) – The name of the webhook.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_action (pulumi.Input[str]) – The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

  • target_pipeline (pulumi.Input[str]) – The name of the pipeline.

The authentication_configuration object supports the following:

  • allowedIpRange (pulumi.Input[str])

  • secretToken (pulumi.Input[str])

The filters object supports the following:

  • jsonPath (pulumi.Input[str])

  • matchEquals (pulumi.Input[str])

authentication = None

The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED.

authentication_configuration = None

An auth block. Required for IP and GITHUB_HMAC. Auth blocks are documented below.

  • allowedIpRange (str)

  • secretToken (str)

filters = None

One or more filter blocks. Filter blocks are documented below.

  • jsonPath (str)

  • matchEquals (str)

name = None

The name of the webhook.

tags = None

A mapping of tags to assign to the resource.

target_action = None

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

target_pipeline = None

The name of the pipeline.

url = None

The CodePipeline webhook’s URL. POST events to this endpoint to trigger the target.

static get(resource_name, id, opts=None, authentication=None, authentication_configuration=None, filters=None, name=None, tags=None, target_action=None, target_pipeline=None, url=None)

Get an existing Webhook resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • authentication (pulumi.Input[str]) – The type of authentication to use. One of IP, GITHUB_HMAC, or UNAUTHENTICATED.

  • authentication_configuration (pulumi.Input[dict]) – An auth block. Required for IP and GITHUB_HMAC. Auth blocks are documented below.

  • filters (pulumi.Input[list]) – One or more filter blocks. Filter blocks are documented below.

  • name (pulumi.Input[str]) – The name of the webhook.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • target_action (pulumi.Input[str]) – The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

  • target_pipeline (pulumi.Input[str]) – The name of the pipeline.

  • url (pulumi.Input[str]) – The CodePipeline webhook’s URL. POST events to this endpoint to trigger the target.

The authentication_configuration object supports the following:

  • allowedIpRange (pulumi.Input[str])

  • secretToken (pulumi.Input[str])

The filters object supports the following:

  • jsonPath (pulumi.Input[str])

  • matchEquals (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str