CfnWebhook
- class aws_cdk.aws_codepipeline.CfnWebhook(scope, id, *, authentication, authentication_configuration, filters, target_action, target_pipeline, target_pipeline_version, name=None, register_with_third_party=None)
Bases:
CfnResource
A CloudFormation
AWS::CodePipeline::Webhook
.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 . .. epigraph:
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.
- CloudformationResource:
AWS::CodePipeline::Webhook
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-webhook.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codepipeline as codepipeline cfn_webhook = codepipeline.CfnWebhook(self, "MyCfnWebhook", authentication="authentication", authentication_configuration=codepipeline.CfnWebhook.WebhookAuthConfigurationProperty( allowed_ip_range="allowedIpRange", secret_token="secretToken" ), filters=[codepipeline.CfnWebhook.WebhookFilterRuleProperty( json_path="jsonPath", # the properties below are optional match_equals="matchEquals" )], target_action="targetAction", target_pipeline="targetPipeline", target_pipeline_version=123, # the properties below are optional name="name", register_with_third_party=False )
Create a new
AWS::CodePipeline::Webhook
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
authentication (
str
) – 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.authentication_configuration (
Union
[IResolvable
,WebhookAuthConfigurationProperty
,Dict
[str
,Any
]]) – Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only theSecretToken
property must be set. For IP, only theAllowedIPRange
property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.filters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,WebhookFilterRuleProperty
,Dict
[str
,Any
]]]]) – 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.target_action (
str
) – 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.target_pipeline (
str
) – The name of the pipeline you want to connect to the webhook.target_pipeline_version (
Union
[int
,float
]) – The version number of the pipeline to be connected to the trigger request. Required: Yes Type: Integer Update requires: No interruptionname (
Optional
[str
]) – The name of the webhook.register_with_third_party (
Union
[bool
,IResolvable
,None
]) – Configures a connection between the webhook that was created and the external tool with events to be detected.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CodePipeline::Webhook'
- attr_url
The webhook URL generated by AWS CodePipeline , such as
https://eu-central-1.webhooks.aws/trigger123456
.- CloudformationAttribute:
Url
- 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.
- authentication_configuration
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 theAllowedIPRange
property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- 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.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the webhook.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- register_with_third_party
Configures a connection between the webhook that was created and the external tool with events to be detected.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- target_action
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.
- target_pipeline
The name of the pipeline you want to connect to the webhook.
- target_pipeline_version
The version number of the pipeline to be connected to the trigger request.
Required: Yes
Type: Integer
Update requires: No interruption
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
WebhookAuthConfigurationProperty
- class CfnWebhook.WebhookAuthConfigurationProperty(*, allowed_ip_range=None, secret_token=None)
Bases:
object
The authentication applied to incoming webhook trigger requests.
- Parameters:
allowed_ip_range (
Optional
[str
]) – The property used to configure acceptance of webhooks in an IP address range. For IP, only theAllowedIPRange
property must be set. This property must be set to a valid CIDR range.secret_token (
Optional
[str
]) – The property used to configure GitHub authentication. For GITHUB_HMAC, only theSecretToken
property must be set.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codepipeline as codepipeline webhook_auth_configuration_property = codepipeline.CfnWebhook.WebhookAuthConfigurationProperty( allowed_ip_range="allowedIpRange", secret_token="secretToken" )
Attributes
- allowed_ip_range
The property used to configure acceptance of webhooks in an IP address range.
For IP, only the
AllowedIPRange
property must be set. This property must be set to a valid CIDR range.
- secret_token
The property used to configure GitHub authentication.
For GITHUB_HMAC, only the
SecretToken
property must be set.
WebhookFilterRuleProperty
- class CfnWebhook.WebhookFilterRuleProperty(*, json_path, match_equals=None)
Bases:
object
The event criteria that specify when a webhook notification is sent to your URL.
- Parameters:
json_path (
str
) – A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in theMatchEquals
field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.match_equals (
Optional
[str
]) – The value selected by theJsonPath
expression must match what is supplied in theMatchEquals
field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is “refs/heads/{Branch}” and the target action has an action configuration property called “Branch” with a value of “main”, theMatchEquals
value is evaluated as “refs/heads/main”. For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codepipeline as codepipeline webhook_filter_rule_property = codepipeline.CfnWebhook.WebhookFilterRuleProperty( json_path="jsonPath", # the properties below are optional match_equals="matchEquals" )
Attributes
- json_path
A JsonPath expression that is applied to the body/payload of the webhook.
The value selected by the JsonPath expression must match the value specified in the
MatchEquals
field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
- match_equals
The value selected by the
JsonPath
expression must match what is supplied in theMatchEquals
field.Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is “refs/heads/{Branch}” and the target action has an action configuration property called “Branch” with a value of “main”, the
MatchEquals
value is evaluated as “refs/heads/main”. For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements .