class CfnWebhookPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodePipeline.Mixins.CfnWebhookPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodepipeline/mixins#CfnWebhookPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.codepipeline.mixins.CfnWebhookPropsMixin
Python	aws_cdk.mixins_preview.aws_codepipeline.mixins.CfnWebhookPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_codepipeline » mixins » CfnWebhookPropsMixin

Implements IMixin

Extends Mixin

The AWS::CodePipeline::Webhook resource creates and registers your webhook.

After the webhook is created and registered, it triggers your pipeline to start every time an external event occurs. For more information, see Migrate polling pipelines to use event-based change detection in the AWS CodePipeline User Guide .

We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have already configured and stored your secret parameters in Secrets Manager. For more information, see Using Dynamic References to Specify Template Values .

When passing secret parameters, do not enter the value directly into the template. The value is rendered as plaintext and is therefore readable. For security reasons, do not use plaintext in your AWS CloudFormation template to store your credentials.

See also: 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 { mixins } from '@aws-cdk/mixins-preview';
import { mixins as codepipeline_mixins } from '@aws-cdk/mixins-preview/aws-codepipeline';
const cfnWebhookPropsMixin = new codepipeline_mixins.CfnWebhookPropsMixin({
  authentication: 'authentication',
  authenticationConfiguration: {
    allowedIpRange: 'allowedIpRange',
    secretToken: 'secretToken',
  },
  filters: [{
    jsonPath: 'jsonPath',
    matchEquals: 'matchEquals',
  }],
  name: 'name',
  registerWithThirdParty: false,
  targetAction: 'targetAction',
  targetPipeline: 'targetPipeline',
  targetPipelineVersion: 123,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnWebhookPropsMixin(props: CfnWebhookMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnWebhookMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CodePipeline::Webhook.

Properties

Name	Type	Description
props	CfnWebhookMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnWebhookMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.