CodeCommitSourceOptions
- class aws_cdk.pipelines.CodeCommitSourceOptions(*, code_build_clone_output=None, event_role=None, trigger=None)
Bases:
object
Configuration options for a CodeCommit source.
- Parameters:
code_build_clone_output (
Optional
[bool
]) – If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files). This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline). Note: if this option is true, only CodeBuild jobs can use the output artifact. Default: falseevent_role (
Optional
[IRole
]) – Role to be used by on commit event rule. Used only when trigger value is CodeCommitTrigger.EVENTS. Default: a new role will be created.trigger (
Optional
[CodeCommitTrigger
]) – How should CodePipeline detect source changes for this Action. Default: CodeCommitTrigger.EVENTS
- 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_actions as codepipeline_actions import aws_cdk.aws_iam as iam import aws_cdk.pipelines as pipelines # role: iam.Role code_commit_source_options = pipelines.CodeCommitSourceOptions( code_build_clone_output=False, event_role=role, trigger=codepipeline_actions.CodeCommitTrigger.NONE )
Attributes
- code_build_clone_output
If this is set, the next CodeBuild job clones the repository (instead of CodePipeline downloading the files).
This provides access to repository history, and retains symlinks (symlinks would otherwise be removed by CodePipeline).
Note: if this option is true, only CodeBuild jobs can use the output artifact.
- event_role
Role to be used by on commit event rule.
Used only when trigger value is CodeCommitTrigger.EVENTS.
- Default:
a new role will be created.
- trigger
How should CodePipeline detect source changes for this Action.
- Default:
CodeCommitTrigger.EVENTS