CfnWebhookProps¶

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

Bases: object

Properties for defining a AWS::CodePipeline::Webhook.

Parameters

authentication (str) – AWS::CodePipeline::Webhook.Authentication.
authentication_configuration (Union[IResolvable, WebhookAuthConfigurationProperty]) – AWS::CodePipeline::Webhook.AuthenticationConfiguration.
filters (Union[IResolvable, Sequence[Union[IResolvable, WebhookFilterRuleProperty]]]) – AWS::CodePipeline::Webhook.Filters.
name (Optional[str]) – AWS::CodePipeline::Webhook.Name.
register_with_third_party (Union[bool, IResolvable, None]) – AWS::CodePipeline::Webhook.RegisterWithThirdParty.
target_action (str) – AWS::CodePipeline::Webhook.TargetAction.
target_pipeline (str) – AWS::CodePipeline::Webhook.TargetPipeline.
target_pipeline_version (Union[int, float]) – AWS::CodePipeline::Webhook.TargetPipelineVersion.

Link

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

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
)