Interface WebhookDefinition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>, SdkBuilder<WebhookDefinition.Builder,WebhookDefinition>, SdkPojo
Enclosing class:
WebhookDefinition
@Mutable @NotThreadSafe public static interface WebhookDefinition.Builder extends SdkPojo, CopyableBuilder<WebhookDefinition.Builder,WebhookDefinition>

  • Method Details

    • name

      WebhookDefinition.Builder name(String name)

      The name of the webhook.

      Parameters:
      name - The name of the webhook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetPipeline

      WebhookDefinition.Builder targetPipeline(String targetPipeline)

      The name of the pipeline you want to connect to the webhook.

      Parameters:
      targetPipeline - The name of the pipeline you want to connect to the webhook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetAction

      WebhookDefinition.Builder targetAction(String targetAction)

      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.

      Parameters:
      targetAction - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      WebhookDefinition.Builder filters(Collection<WebhookFilterRule> filters)

      A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

      Parameters:
      filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      WebhookDefinition.Builder filters(WebhookFilterRule... filters)

      A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

      Parameters:
      filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      WebhookDefinition.Builder filters(Consumer<WebhookFilterRule.Builder>... filters)

      A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

      This is a convenience method that creates an instance of the WebhookFilterRule.Builder avoiding the need to create one manually via WebhookFilterRule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<WebhookFilterRule>).

      Parameters:
      filters - a consumer that will call methods on WebhookFilterRule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authentication

      WebhookDefinition.Builder authentication(String authentication)

      Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

      When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

      If a secret token was provided, it will be redacted in the response.

      • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

      • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

      • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

      Parameters:
      authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

      When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

      If a secret token was provided, it will be redacted in the response.

      • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

      • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

      • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authentication

      WebhookDefinition.Builder authentication(WebhookAuthenticationType authentication)

      Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

      When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

      If a secret token was provided, it will be redacted in the response.

      • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

      • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

      • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

      Parameters:
      authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

      When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

      If a secret token was provided, it will be redacted in the response.

      • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

      • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

      • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationConfiguration

      WebhookDefinition.Builder authenticationConfiguration(WebhookAuthConfiguration authenticationConfiguration)

      Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

      Parameters:
      authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationConfiguration

      default WebhookDefinition.Builder authenticationConfiguration(Consumer<WebhookAuthConfiguration.Builder> authenticationConfiguration)

      Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

      This is a convenience method that creates an instance of the WebhookAuthConfiguration.Builder avoiding the need to create one manually via WebhookAuthConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationConfiguration(WebhookAuthConfiguration).

      Parameters:
      authenticationConfiguration - a consumer that will call methods on WebhookAuthConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: