Create Sync Configuration
codestarconnections_create_sync_configuration | R Documentation |
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource¶
Description¶
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.
Usage¶
codestarconnections_create_sync_configuration(Branch, ConfigFile,
RepositoryLinkId, ResourceName, RoleArn, SyncType,
PublishDeploymentStatus, TriggerResourceUpdateOn)
Arguments¶
Branch
[required] The branch in the repository from which changes will be synced.
ConfigFile
[required] The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.
RepositoryLinkId
[required] 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.
ResourceName
[required] 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.
RoleArn
[required] 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.
SyncType
[required] The type of sync configuration.
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"
)
)