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.UpdateWebhook

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the webhook associated with an CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

Synopsis

data UpdateWebhook = UpdateWebhook' {
- branchFilter :: Maybe Text
- rotateSecret :: Maybe Bool
- filterGroups :: Maybe [[WebhookFilter]]
- buildType :: Maybe WebhookBuildType
- projectName :: Text
}
newUpdateWebhook :: Text -> UpdateWebhook
updateWebhook_branchFilter :: Lens' UpdateWebhook (Maybe Text)
updateWebhook_rotateSecret :: Lens' UpdateWebhook (Maybe Bool)
updateWebhook_filterGroups :: Lens' UpdateWebhook (Maybe [[WebhookFilter]])
updateWebhook_buildType :: Lens' UpdateWebhook (Maybe WebhookBuildType)
updateWebhook_projectName :: Lens' UpdateWebhook Text
data UpdateWebhookResponse = UpdateWebhookResponse' {
- webhook :: Maybe Webhook
- httpStatus :: Int
}
newUpdateWebhookResponse :: Int -> UpdateWebhookResponse
updateWebhookResponse_webhook :: Lens' UpdateWebhookResponse (Maybe Webhook)
updateWebhookResponse_httpStatus :: Lens' UpdateWebhookResponse Int

Creating a Request

data UpdateWebhook Source #

See: newUpdateWebhook smart constructor.

Constructors

UpdateWebhook'

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.
rotateSecret :: Maybe Bool
A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.
filterGroups :: Maybe [[WebhookFilter]]
An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.
buildType :: Maybe WebhookBuildType
Specifies the type of build this webhook will trigger.
projectName :: Text
The name of the CodeBuild project.

Instances

Instances details

Eq UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods (==) :: UpdateWebhook -> UpdateWebhook -> Bool # (/=) :: UpdateWebhook -> UpdateWebhook -> Bool #
Read UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods readsPrec :: Int -> ReadS UpdateWebhook # readList :: ReadS [UpdateWebhook] # readPrec :: ReadPrec UpdateWebhook # readListPrec :: ReadPrec [UpdateWebhook] #
Show UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods showsPrec :: Int -> UpdateWebhook -> ShowS # show :: UpdateWebhook -> String # showList :: [UpdateWebhook] -> ShowS #
Generic UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Associated Types type Rep UpdateWebhook :: Type -> Type # Methods from :: UpdateWebhook -> Rep UpdateWebhook x # to :: Rep UpdateWebhook x -> UpdateWebhook #
NFData UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods rnf :: UpdateWebhook -> () #
Hashable UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods hashWithSalt :: Int -> UpdateWebhook -> Int # hash :: UpdateWebhook -> Int #
ToJSON UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods toJSON :: UpdateWebhook -> Value # toEncoding :: UpdateWebhook -> Encoding # toJSONList :: [UpdateWebhook] -> Value # toEncodingList :: [UpdateWebhook] -> Encoding #
AWSRequest UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Associated Types type AWSResponse UpdateWebhook # Methods request :: UpdateWebhook -> Request UpdateWebhook # response :: MonadResource m => Logger -> Service -> Proxy UpdateWebhook -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWebhook))) #
ToHeaders UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods toHeaders :: UpdateWebhook -> [Header] #
ToPath UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods toPath :: UpdateWebhook -> ByteString #
ToQuery UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods toQuery :: UpdateWebhook -> QueryString #
type Rep UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook type Rep UpdateWebhook = D1 ('MetaData "UpdateWebhook" "Amazonka.CodeBuild.UpdateWebhook" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "UpdateWebhook'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "branchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "rotateSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "filterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[WebhookFilter]])) :: (S1 ('MetaSel ('Just "buildType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebhookBuildType)) :: S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateWebhook Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook type AWSResponse UpdateWebhook = UpdateWebhookResponse

newUpdateWebhook Source #

Arguments

:: Text	`$sel:projectName:UpdateWebhook'`
-> UpdateWebhook

Create a value of UpdateWebhook 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:UpdateWebhook', updateWebhook_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:rotateSecret:UpdateWebhook', updateWebhook_rotateSecret - A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

$sel:filterGroups:UpdateWebhook', updateWebhook_filterGroups - An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

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

$sel:projectName:UpdateWebhook', updateWebhook_projectName - The name of the CodeBuild project.

Request Lenses

updateWebhook_branchFilter :: Lens' UpdateWebhook (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.

updateWebhook_rotateSecret :: Lens' UpdateWebhook (Maybe Bool) Source #

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

updateWebhook_filterGroups :: Lens' UpdateWebhook (Maybe [[WebhookFilter]]) Source #

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

updateWebhook_buildType :: Lens' UpdateWebhook (Maybe WebhookBuildType) Source #

Specifies the type of build this webhook will trigger.

updateWebhook_projectName :: Lens' UpdateWebhook Text Source #

The name of the CodeBuild project.

Destructuring the Response

data UpdateWebhookResponse Source #

See: newUpdateWebhookResponse smart constructor.

Constructors

UpdateWebhookResponse'
Fields webhook :: Maybe Webhook Information about a repository's webhook that is associated with a project in CodeBuild. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods (==) :: UpdateWebhookResponse -> UpdateWebhookResponse -> Bool # (/=) :: UpdateWebhookResponse -> UpdateWebhookResponse -> Bool #
Read UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods readsPrec :: Int -> ReadS UpdateWebhookResponse # readList :: ReadS [UpdateWebhookResponse] # readPrec :: ReadPrec UpdateWebhookResponse # readListPrec :: ReadPrec [UpdateWebhookResponse] #
Show UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods showsPrec :: Int -> UpdateWebhookResponse -> ShowS # show :: UpdateWebhookResponse -> String # showList :: [UpdateWebhookResponse] -> ShowS #
Generic UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Associated Types type Rep UpdateWebhookResponse :: Type -> Type # Methods from :: UpdateWebhookResponse -> Rep UpdateWebhookResponse x # to :: Rep UpdateWebhookResponse x -> UpdateWebhookResponse #
NFData UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook Methods rnf :: UpdateWebhookResponse -> () #
type Rep UpdateWebhookResponse Source #
Instance details Defined in Amazonka.CodeBuild.UpdateWebhook type Rep UpdateWebhookResponse = D1 ('MetaData "UpdateWebhookResponse" "Amazonka.CodeBuild.UpdateWebhook" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "UpdateWebhookResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "webhook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Webhook)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateWebhookResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateWebhookResponse'`
-> UpdateWebhookResponse

Create a value of UpdateWebhookResponse 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:webhook:UpdateWebhookResponse', updateWebhookResponse_webhook - Information about a repository's webhook that is associated with a project in CodeBuild.

$sel:httpStatus:UpdateWebhookResponse', updateWebhookResponse_httpStatus - The response's http status code.

Response Lenses

updateWebhookResponse_webhook :: Lens' UpdateWebhookResponse (Maybe Webhook) Source #

Information about a repository's webhook that is associated with a project in CodeBuild.

updateWebhookResponse_httpStatus :: Lens' UpdateWebhookResponse Int Source #

The response's http status code.