CfnWebhookProps

class aws_cdk.aws_amplify.CfnWebhookProps(*, branch_name, app_id=None, description=None, tags=None)

Bases: object

Properties for defining a CfnWebhook.

Parameters:

branch_name (str) – The name for a branch that is part of an Amplify app.
app_id (Optional[str]) – The unique ID for an Amplify app.
description (Optional[str]) – The description for a webhook.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags for the webhook.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_amplify as amplify

cfn_webhook_props = amplify.CfnWebhookProps(
    branch_name="branchName",

    # the properties below are optional
    app_id="appId",
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_id

The unique ID for an Amplify app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-webhook.html#cfn-amplify-webhook-appid

branch_name

The name for a branch that is part of an Amplify app.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-webhook.html#cfn-amplify-webhook-branchname

description

The description for a webhook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-webhook.html#cfn-amplify-webhook-description

tags

Tags for the webhook.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-webhook.html#cfn-amplify-webhook-tags