Valid settings for the PollForSourceChanges parameter (original) (raw)
The PollForSourceChanges
parameter default is determined by the method used to create the pipeline, as described in the following table. In many cases, thePollForSourceChanges
parameter defaults to true and must be disabled.
When the PollForSourceChanges
parameter defaults to true, you should do the following:
- Add the
PollForSourceChanges
parameter to the JSON file or AWS CloudFormation template. - Create change detection resources (CloudWatch Events rule, as applicable).
- Set the
PollForSourceChanges
parameter to false.
Note
If you create a CloudWatch Events rule or webhook, you must set the parameter to false to avoid triggering the pipeline more than once.
The PollForSourceChanges
parameter is not used for Amazon ECR source actions.
- PollForSourceChanges parameter defaults
Source Creation method Example "configuration" JSON structure output CodeCommit Pipeline is created with the console (and change detection resources are created by the console). The parameter is displayed in the pipeline structure output and defaults tofalse. BranchName": "main", "PollForSourceChanges": "false", "RepositoryName": "my-repo" Pipeline is created with the CLI or AWS CloudFormation, and thePollForSourceChanges parameter is not displayed in JSON output, but it sets to true.² BranchName": "main", "RepositoryName": "my-repo" Amazon S3 Pipeline is created with the console (and change detection resources are created by the console). The parameter is displayed in the pipeline structure output and defaults tofalse. "S3Bucket": "my-bucket", "S3ObjectKey": "object.zip", "PollForSourceChanges": "false" Pipeline is created with the CLI or AWS CloudFormation, and thePollForSourceChanges parameter is not displayed in JSON output, but it sets to true.² "S3Bucket": "my-bucket", "S3ObjectKey": "object.zip" GitHub Pipeline is created with the console (and change detection resources are created by the console). The parameter is displayed in the pipeline structure output and defaults tofalse. "Owner": "MyGitHubAccountName", "Repo": "MyGitHubRepositoryName" "PollForSourceChanges": "false", "Branch": "main" "OAuthToken": "****" Pipeline is created with the CLI or AWS CloudFormation, and thePollForSourceChanges parameter is not displayed in JSON output, but it sets to true.² "Owner": "MyGitHubAccountName", "Repo": "MyGitHubRepositoryName", "Branch": "main", "OAuthToken": "****" ² If PollForSourceChanges has been added at any point to the JSON structure or the AWS CloudFormation template, it is displayed as shown: "PollForSourceChanges": "true", ³ For information about the change detection resources that apply to each source provider, see Change Detection Methods.
Valid action providers in CodePipeline
Valid input and output artifacts for each action type
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.