Skip to content
v2.277.0

CfnWebhookProps Struct ​

Properties for defining a CfnWebhook.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const cfnWebhookProps: amplify.CfnWebhookProps = {
  branchName: 'branchName',

  // the properties below are optional
  appId: 'appId',
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
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"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplify.*;

CfnWebhookProps cfnWebhookProps = CfnWebhookProps.builder()
        .branchName("branchName")

        // the properties below are optional
        .appId("appId")
        .description("description")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify;

var cfnWebhookProps = new CfnWebhookProps {
    BranchName = "branchName",

    // the properties below are optional
    AppId = "appId",
    Description = "description",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWebhookProps := &CfnWebhookProps{
	BranchName: jsii.String("branchName"),

	// the properties below are optional
	AppId: jsii.String("appId"),
	Description: jsii.String("description"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

appIdoptionalstringapp_idoptionalstrappIdoptionalStringAppIdoptionalstringAppIdoptional*string#
The unique ID for an Amplify app.
branchNamestringbranch_namestrbranchNameStringBranchNamestringBranchName*stringrequired#
The name for a branch that is part of an Amplify app.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description for a webhook.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Tags for the webhook.