Skip to content

SyncConfiguration

Source code in docs_src/capo_codestar_connections/types/sync_configuration.py 
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
48
49
50
51
52
53
54
55
class SyncConfiguration(TypedDict, closed=True):
    branch: "capo_codestar_connections.types.branch_name.BranchName"
    """<p>The branch associated with a specific sync configuration.</p>"""
    config_file: NotRequired[
        "capo_codestar_connections.types.deployment_file_path.DeploymentFilePath"
    ]
    """<p>The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.</p>"""
    owner_id: "capo_codestar_connections.types.owner_id.OwnerId"
    """<p>The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.</p>"""
    provider_type: "capo_codestar_connections.types.provider_type.ProviderType"
    """<p>The connection provider type associated with a specific sync configuration, such as GitHub.</p>"""
    repository_link_id: (
        "capo_codestar_connections.types.repository_link_id.RepositoryLinkId"
    )
    """<p>The ID of the repository link associated with a specific sync configuration.</p>"""
    repository_name: "capo_codestar_connections.types.repository_name.RepositoryName"
    """<p>The name of the repository associated with a specific sync configuration.</p>"""
    resource_name: "capo_codestar_connections.types.resource_name.ResourceName"
    """<p>The name of the connection resource associated with a specific sync configuration.</p>"""
    role_arn: "capo_codestar_connections.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.</p>"""
    sync_type: (
        "capo_codestar_connections.types.sync_configuration_type.SyncConfigurationType"
    )
    """<p>The type of sync for a specific sync configuration.</p>"""
    publish_deployment_status: NotRequired[
        "capo_codestar_connections.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_codestar_connections.types.trigger_resource_update_on.TriggerResourceUpdateOn"
    ]
    """<p>When to trigger Git sync to begin the stack update.</p>"""

branch instance-attribute 

branch: BranchName

The branch associated with a specific sync configuration.

config_file instance-attribute 

config_file: NotRequired[DeploymentFilePath]

The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

owner_id instance-attribute 

owner_id: OwnerId

The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

provider_type instance-attribute 

provider_type: ProviderType

The connection provider type associated with a specific sync configuration, such as GitHub.

publish_deployment_status instance-attribute 

publish_deployment_status: NotRequired[PublishDeploymentStatus]

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

repository_link_id: RepositoryLinkId

The ID of the repository link associated with a specific sync configuration.

repository_name instance-attribute 

repository_name: RepositoryName

The name of the repository associated with a specific sync configuration.

resource_name instance-attribute 

resource_name: ResourceName

The name of the connection resource associated with a specific sync configuration.

role_arn instance-attribute 

role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

sync_type instance-attribute 

sync_type: SyncConfigurationType

The type of sync for a specific sync configuration.

trigger_resource_update_on instance-attribute 

trigger_resource_update_on: NotRequired[TriggerResourceUpdateOn]

When to trigger Git sync to begin the stack update.