Package com.pulumi.aws.codepipeline
Class Webhook
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.codepipeline.Webhook
-
public class Webhook extends com.pulumi.resources.CustomResourceProvides a CodePipeline Webhook. ## Example Usage
## Import ### Identity Schema #### Required - `arn` (String) ARN of the CodePipeline webhook. Using `pulumi import`, import CodePipeline Webhooks using their ARN. For example: ```sh $ pulumi import aws:codepipeline/webhook:Webhook example arn:aws:codepipeline:us-west-2:123456789012:webhook:example ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.codepipeline.Pipeline; import com.pulumi.aws.codepipeline.PipelineArgs; import com.pulumi.aws.codepipeline.inputs.PipelineArtifactStoreArgs; import com.pulumi.aws.codepipeline.inputs.PipelineArtifactStoreEncryptionKeyArgs; import com.pulumi.aws.codepipeline.inputs.PipelineStageArgs; import com.pulumi.aws.codepipeline.inputs.PipelineStageActionArgs; import com.pulumi.aws.codepipeline.Webhook; import com.pulumi.aws.codepipeline.WebhookArgs; import com.pulumi.aws.codepipeline.inputs.WebhookAuthenticationConfigurationArgs; import com.pulumi.aws.codepipeline.inputs.WebhookFilterArgs; import com.pulumi.github.RepositoryWebhook; import com.pulumi.github.RepositoryWebhookArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var bar = new Pipeline("bar", PipelineArgs.builder() .artifactStores(PipelineArtifactStoreArgs.builder() .encryptionKey(PipelineArtifactStoreEncryptionKeyArgs.builder() .id(s3kmskey.arn()) .type("KMS") .build()) .location(barAwsS3Bucket.bucket()) .type("S3") .build()) .stages( PipelineStageArgs.builder() .actions(PipelineStageActionArgs.builder() .name("Source") .category("Source") .owner("ThirdParty") .provider("GitHub") .version("1") .outputArtifacts("test") .configuration(Map.ofEntries( Map.entry("Owner", "my-organization"), Map.entry("Repo", "test"), Map.entry("Branch", "master") )) .build()) .name("Source") .build(), PipelineStageArgs.builder() .actions(PipelineStageActionArgs.builder() .name("Build") .category("Build") .owner("AWS") .provider("CodeBuild") .inputArtifacts("test") .version("1") .configuration(Map.of("ProjectName", "test")) .build()) .name("Build") .build()) .name("tf-test-pipeline") .roleArn(barAwsIamRole.arn()) .build()); final var webhookSecret = "super-secret"; var barWebhook = new Webhook("barWebhook", WebhookArgs.builder() .authenticationConfiguration(WebhookAuthenticationConfigurationArgs.builder() .secretToken(webhookSecret) .build()) .filters(WebhookFilterArgs.builder() .jsonPath("$.ref") .matchEquals("refs/heads/{Branch}") .build()) .name("test-webhook-github-bar") .authentication("GITHUB_HMAC") .targetAction("Source") .targetPipeline(bar.name()) .build()); // Wire the CodePipeline webhook into a GitHub repository. var barRepositoryWebhook = new RepositoryWebhook("barRepositoryWebhook", RepositoryWebhookArgs.builder() .configuration(com.pulumi.github.inputs.RepositoryWebhookConfigurationArgs.builder() .url(barWebhook.url()) .contentType("json") .insecureSsl(true) .secret(webhookSecret) .build()) .repository(repo.name()) .name("web") .events("push") .build()); } }
-
-
Constructor Summary
Constructors Constructor Description Webhook(java.lang.String name)Webhook(java.lang.String name, WebhookArgs args)Webhook(java.lang.String name, WebhookArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.lang.String>authentication()com.pulumi.core.Output<java.util.Optional<WebhookAuthenticationConfiguration>>authenticationConfiguration()com.pulumi.core.Output<java.util.List<WebhookFilter>>filters()static Webhookget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, WebhookState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>name()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.String>targetAction()com.pulumi.core.Output<java.lang.String>targetPipeline()com.pulumi.core.Output<java.lang.String>url()
-
-
-
Constructor Detail
-
Webhook
public Webhook(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Webhook
public Webhook(java.lang.String name, WebhookArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Webhook
public Webhook(java.lang.String name, WebhookArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- The CodePipeline webhook's ARN.
-
authentication
public com.pulumi.core.Output<java.lang.String> authentication()
- Returns:
- The type of authentication to use. One of `IP`, `GITHUB_HMAC`, or `UNAUTHENTICATED`.
-
authenticationConfiguration
public com.pulumi.core.Output<java.util.Optional<WebhookAuthenticationConfiguration>> authenticationConfiguration()
- Returns:
- An `auth` block. Required for `IP` and `GITHUB_HMAC`. Auth blocks are documented below.
-
filters
public com.pulumi.core.Output<java.util.List<WebhookFilter>> filters()
- Returns:
- One or more `filter` blocks. Filter blocks are documented below.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- The name of the webhook.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
targetAction
public com.pulumi.core.Output<java.lang.String> targetAction()
- Returns:
- 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.
-
targetPipeline
public com.pulumi.core.Output<java.lang.String> targetPipeline()
- Returns:
- The name of the pipeline.
-
url
public com.pulumi.core.Output<java.lang.String> url()
- Returns:
- The CodePipeline webhook's URL. POST events to this endpoint to trigger the target.
-
get
public static Webhook get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable WebhookState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-