Get Sync Configuration

codestarconnections_get_sync_configuration

R Documentation

Returns details about a sync configuration, including the sync type and resource name¶

Description¶

Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.

Usage¶

codestarconnections_get_sync_configuration(SyncType, ResourceName)

Arguments¶

SyncType: [required] The sync type for the sync configuration for which you want to retrieve information.
ResourceName: [required] The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.

Value¶

A list with the following syntax:

list(
  SyncConfiguration = list(
    Branch = "string",
    ConfigFile = "string",
    OwnerId = "string",
    ProviderType = "Bitbucket"|"GitHub"|"GitHubEnterpriseServer"|"GitLab"|"GitLabSelfManaged",
    RepositoryLinkId = "string",
    RepositoryName = "string",
    ResourceName = "string",
    RoleArn = "string",
    SyncType = "CFN_STACK_SYNC",
    PublishDeploymentStatus = "ENABLED"|"DISABLED",
    TriggerResourceUpdateOn = "ANY_CHANGE"|"FILE_CHANGE"
  )
)

Request syntax¶

svc$get_sync_configuration(
  SyncType = "CFN_STACK_SYNC",
  ResourceName = "string"
)