Skip to content

CreateSyncConfigurationInput

Source code in docs_src/capo_codeconnections/types/create_sync_configuration_input.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class CreateSyncConfigurationInput(TypedDict, closed=True):
    branch: "capo_codeconnections.types.branch_name.BranchName"
    """<p>The branch in the repository from which changes will be synced.</p>"""
    config_file: "capo_codeconnections.types.deployment_file_path.DeploymentFilePath"
    """<p>The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.</p>"""
    repository_link_id: "capo_codeconnections.types.repository_link_id.RepositoryLinkId"
    """<p>The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.</p>"""
    resource_name: "capo_codeconnections.types.resource_name.ResourceName"
    """<p>The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.</p>"""
    role_arn: "capo_codeconnections.types.iam_role_arn.IamRoleArn"
    """<p>The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.</p>"""
    sync_type: (
        "capo_codeconnections.types.sync_configuration_type.SyncConfigurationType"
    )
    """<p>The type of sync configuration.</p>"""
    publish_deployment_status: NotRequired[
        "capo_codeconnections.types.publish_deployment_status.PublishDeploymentStatus"
    ]
    """<p>Whether to enable or disable publishing of deployment status to source providers.</p>"""
    trigger_resource_update_on: NotRequired[
        "capo_codeconnections.types.trigger_resource_update_on.TriggerResourceUpdateOn"
    ]
    """<p>When to trigger Git sync to begin the stack update.</p>"""
    pull_request_comment: NotRequired[
        "capo_codeconnections.types.pull_request_comment.PullRequestComment"
    ]
    """<p>A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.</p>"""

branch instance-attribute 

branch: BranchName

The branch in the repository from which changes will be synced.

config_file instance-attribute 

config_file: DeploymentFilePath

The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

publish_deployment_status instance-attribute 

publish_deployment_status: NotRequired[PublishDeploymentStatus]

Whether to enable or disable publishing of deployment status to source providers.

pull_request_comment instance-attribute 

pull_request_comment: NotRequired[PullRequestComment]

A toggle that specifies whether to enable or disable pull request comments for the sync configuration to be created.

repository_link_id: RepositoryLinkId

The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

resource_name instance-attribute 

resource_name: ResourceName

The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

role_arn instance-attribute 

role_arn: IamRoleArn

The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

sync_type instance-attribute 

sync_type: SyncConfigurationType

The type of sync configuration.

trigger_resource_update_on instance-attribute 

trigger_resource_update_on: NotRequired[TriggerResourceUpdateOn]

When to trigger Git sync to begin the stack update.