Skip to content

Update Sync Configuration

codestarconnections_update_sync_configuration R Documentation

Updates the sync configuration for your connection and a specified external Git repository

Description

Updates the sync configuration for your connection and a specified external Git repository.

Usage

codestarconnections_update_sync_configuration(Branch, ConfigFile,
  RepositoryLinkId, ResourceName, RoleArn, SyncType,
  PublishDeploymentStatus, TriggerResourceUpdateOn)

Arguments

Branch

The branch for the sync configuration to be updated.

ConfigFile

The configuration file for the sync configuration to be updated.

RepositoryLinkId

The ID of the repository link for the sync configuration to be updated.

ResourceName

[required] The name of the Amazon Web Services resource for the sync configuration to be updated.

RoleArn

The ARN of the IAM role for the sync configuration to be updated.

SyncType

[required] The sync type for the sync configuration to be updated.

PublishDeploymentStatus

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

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

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$update_sync_configuration(
  Branch = "string",
  ConfigFile = "string",
  RepositoryLinkId = "string",
  ResourceName = "string",
  RoleArn = "string",
  SyncType = "CFN_STACK_SYNC",
  PublishDeploymentStatus = "ENABLED"|"DISABLED",
  TriggerResourceUpdateOn = "ANY_CHANGE"|"FILE_CHANGE"
)