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.CodePipeline.Types.WebhookDefinition

Description

Documentation

data WebhookDefinition Source #

Represents information about a webhook and its definition.

See: newWebhookDefinition smart constructor.

Constructors

WebhookDefinition'

Fields

name :: Text
The name of the webhook.
targetPipeline :: Text
The name of the pipeline you want to connect to the webhook.
targetAction :: Text
The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
filters :: [WebhookFilterRule]
A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
authentication :: WebhookAuthenticationType
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
- For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
- IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
- UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
authenticationConfiguration :: WebhookAuthConfiguration
Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Instances

Instances details

Eq WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods (==) :: WebhookDefinition -> WebhookDefinition -> Bool # (/=) :: WebhookDefinition -> WebhookDefinition -> Bool #
Read WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods readsPrec :: Int -> ReadS WebhookDefinition # readList :: ReadS [WebhookDefinition] # readPrec :: ReadPrec WebhookDefinition # readListPrec :: ReadPrec [WebhookDefinition] #
Show WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods showsPrec :: Int -> WebhookDefinition -> ShowS # show :: WebhookDefinition -> String # showList :: [WebhookDefinition] -> ShowS #
Generic WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Associated Types type Rep WebhookDefinition :: Type -> Type # Methods from :: WebhookDefinition -> Rep WebhookDefinition x # to :: Rep WebhookDefinition x -> WebhookDefinition #
NFData WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods rnf :: WebhookDefinition -> () #
Hashable WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods hashWithSalt :: Int -> WebhookDefinition -> Int # hash :: WebhookDefinition -> Int #
ToJSON WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods toJSON :: WebhookDefinition -> Value # toEncoding :: WebhookDefinition -> Encoding # toJSONList :: [WebhookDefinition] -> Value # toEncodingList :: [WebhookDefinition] -> Encoding #
FromJSON WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition Methods parseJSON :: Value -> Parser WebhookDefinition # parseJSONList :: Value -> Parser [WebhookDefinition] #
type Rep WebhookDefinition Source #
Instance details Defined in Amazonka.CodePipeline.Types.WebhookDefinition type Rep WebhookDefinition = D1 ('MetaData "WebhookDefinition" "Amazonka.CodePipeline.Types.WebhookDefinition" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "WebhookDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "targetPipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WebhookFilterRule]) :: (S1 ('MetaSel ('Just "authentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WebhookAuthenticationType) :*: S1 ('MetaSel ('Just "authenticationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WebhookAuthConfiguration)))))

newWebhookDefinition Source #

Arguments

:: Text	`$sel:name:WebhookDefinition'`
-> Text	`$sel:targetPipeline:WebhookDefinition'`
-> Text	`$sel:targetAction:WebhookDefinition'`
-> WebhookAuthenticationType	`$sel:authentication:WebhookDefinition'`
-> WebhookAuthConfiguration	`$sel:authenticationConfiguration:WebhookDefinition'`
-> WebhookDefinition

Create a value of WebhookDefinition 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:name:WebhookDefinition', webhookDefinition_name - The name of the webhook.

$sel:targetPipeline:WebhookDefinition', webhookDefinition_targetPipeline - The name of the pipeline you want to connect to the webhook.

$sel:targetAction:WebhookDefinition', webhookDefinition_targetAction - The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

$sel:filters:WebhookDefinition', webhookDefinition_filters - A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

$sel:authentication:WebhookDefinition', webhookDefinition_authentication - Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

$sel:authenticationConfiguration:WebhookDefinition', webhookDefinition_authenticationConfiguration - Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

webhookDefinition_name :: Lens' WebhookDefinition Text Source #

The name of the webhook.

webhookDefinition_targetPipeline :: Lens' WebhookDefinition Text Source #

The name of the pipeline you want to connect to the webhook.

webhookDefinition_targetAction :: Lens' WebhookDefinition Text Source #

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

webhookDefinition_filters :: Lens' WebhookDefinition [WebhookFilterRule] Source #

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

webhookDefinition_authentication :: Lens' WebhookDefinition WebhookAuthenticationType Source #

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

webhookDefinition_authenticationConfiguration :: Lens' WebhookDefinition WebhookAuthConfiguration Source #

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.