CfnWebhookProps

class aws_cdk.aws_codepipeline.CfnWebhookProps(*, authentication, authentication_configuration, filters, target_action, target_pipeline, target_pipeline_version, name=None, register_with_third_party=None)

Bases: object

Properties for defining a CfnWebhook.

Parameters
  • authentication (str) – Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. - 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.

  • authentication_configuration (Union[IResolvable, WebhookAuthConfigurationProperty]) – 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.

  • filters (Union[IResolvable, Sequence[Union[IResolvable, WebhookFilterRuleProperty]]]) – 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.

  • target_action (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 (str) – The name of the pipeline you want to connect to the webhook.

  • target_pipeline_version (Union[int, float]) – The version number of the pipeline to be connected to the trigger request. Required: Yes Type: Integer Update requires: No interruption

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

  • register_with_third_party (Union[bool, IResolvable, None]) – Configures a connection between the webhook that was created and the external tool with events to be detected.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codepipeline as codepipeline

cfn_webhook_props = codepipeline.CfnWebhookProps(
    authentication="authentication",
    authentication_configuration=codepipeline.CfnWebhook.WebhookAuthConfigurationProperty(
        allowed_ip_range="allowedIpRange",
        secret_token="secretToken"
    ),
    filters=[codepipeline.CfnWebhook.WebhookFilterRuleProperty(
        json_path="jsonPath",

        # the properties below are optional
        match_equals="matchEquals"
    )],
    target_action="targetAction",
    target_pipeline="targetPipeline",
    target_pipeline_version=123,

    # the properties below are optional
    name="name",
    register_with_third_party=False
)

Attributes

authentication

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authentication

Return type

str

authentication_configuration

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-authenticationconfiguration

Return type

Union[IResolvable, WebhookAuthConfigurationProperty]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-filters

Return type

Union[IResolvable, List[Union[IResolvable, WebhookFilterRuleProperty]]]

name

The name of the webhook.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-name

Return type

Optional[str]

register_with_third_party

Configures a connection between the webhook that was created and the external tool with events to be detected.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-registerwiththirdparty

Return type

Union[bool, IResolvable, None]

target_action

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetaction

Return type

str

target_pipeline

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipeline

Return type

str

target_pipeline_version

The version number of the pipeline to be connected to the trigger request.

Required: Yes

Type: Integer

Update requires: No interruption

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html#cfn-codepipeline-webhook-targetpipelineversion

Return type

Union[int, float]