Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeBuild.Types.Webhook

Description

Synopsis

data Webhook = Webhook' {
- branchFilter :: Maybe Text
- lastModifiedSecret :: Maybe POSIX
- url :: Maybe Text
- secret :: Maybe Text
- filterGroups :: Maybe [[WebhookFilter]]
- payloadUrl :: Maybe Text
- buildType :: Maybe WebhookBuildType
}
newWebhook :: Webhook
webhook_branchFilter :: Lens' Webhook (Maybe Text)
webhook_lastModifiedSecret :: Lens' Webhook (Maybe UTCTime)
webhook_url :: Lens' Webhook (Maybe Text)
webhook_secret :: Lens' Webhook (Maybe Text)
webhook_filterGroups :: Lens' Webhook (Maybe [[WebhookFilter]])
webhook_payloadUrl :: Lens' Webhook (Maybe Text)
webhook_buildType :: Lens' Webhook (Maybe WebhookBuildType)

Documentation

data Webhook Source #

Information about a webhook that connects repository events to a build project in CodeBuild.

See: newWebhook smart constructor.

Constructors

Webhook'

Fields

branchFilter :: Maybe Text
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
lastModifiedSecret :: Maybe POSIX
A timestamp that indicates the last time a repository's secret token was modified.
url :: Maybe Text
The URL to the webhook.
secret :: Maybe Text
The secret token of the associated repository.
A Bitbucket webhook does not support secret.
filterGroups :: Maybe [[WebhookFilter]]
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
payloadUrl :: Maybe Text
The CodeBuild endpoint where webhook events are sent.
buildType :: Maybe WebhookBuildType
Specifies the type of build this webhook will trigger.

Instances

Instances details

Eq Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods (==) :: Webhook -> Webhook -> Bool # (/=) :: Webhook -> Webhook -> Bool #
Read Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods readsPrec :: Int -> ReadS Webhook # readList :: ReadS [Webhook] # readPrec :: ReadPrec Webhook # readListPrec :: ReadPrec [Webhook] #
Show Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods showsPrec :: Int -> Webhook -> ShowS # show :: Webhook -> String # showList :: [Webhook] -> ShowS #
Generic Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Associated Types type Rep Webhook :: Type -> Type # Methods from :: Webhook -> Rep Webhook x # to :: Rep Webhook x -> Webhook #
NFData Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods rnf :: Webhook -> () #
Hashable Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods hashWithSalt :: Int -> Webhook -> Int # hash :: Webhook -> Int #
FromJSON Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook Methods parseJSON :: Value -> Parser Webhook # parseJSONList :: Value -> Parser [Webhook] #
type Rep Webhook Source #
Instance details Defined in Amazonka.CodeBuild.Types.Webhook type Rep Webhook = D1 ('MetaData "Webhook" "Amazonka.CodeBuild.Types.Webhook" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "Webhook'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "branchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModifiedSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "secret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[WebhookFilter]]))) :: (S1 ('MetaSel ('Just "payloadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "buildType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebhookBuildType))))))

newWebhook :: Webhook Source #

Create a value of Webhook with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:branchFilter:Webhook', webhook_branchFilter - A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

$sel:lastModifiedSecret:Webhook', webhook_lastModifiedSecret - A timestamp that indicates the last time a repository's secret token was modified.

$sel:url:Webhook', webhook_url - The URL to the webhook.

$sel:secret:Webhook', webhook_secret - The secret token of the associated repository.

A Bitbucket webhook does not support secret.

$sel:filterGroups:Webhook', webhook_filterGroups - An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

$sel:payloadUrl:Webhook', webhook_payloadUrl - The CodeBuild endpoint where webhook events are sent.

$sel:buildType:Webhook', webhook_buildType - Specifies the type of build this webhook will trigger.

webhook_branchFilter :: Lens' Webhook (Maybe Text) Source #

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

webhook_lastModifiedSecret :: Lens' Webhook (Maybe UTCTime) Source #

A timestamp that indicates the last time a repository's secret token was modified.

webhook_url :: Lens' Webhook (Maybe Text) Source #

The URL to the webhook.

webhook_secret :: Lens' Webhook (Maybe Text) Source #

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

webhook_filterGroups :: Lens' Webhook (Maybe [[WebhookFilter]]) Source #

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

webhook_payloadUrl :: Lens' Webhook (Maybe Text) Source #

The CodeBuild endpoint where webhook events are sent.

webhook_buildType :: Lens' Webhook (Maybe WebhookBuildType) Source #

Specifies the type of build this webhook will trigger.