Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1427150102.0 KB

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.

post/#X-Amz-Target=com.amazonaws.codeconnections.CodeConnections_20231201.CreateSyncConfiguration

Headers

X-Amz-Target'com.amazonaws.codeconnections.CodeConnections_20231201.CreateSyncConfiguration' required

Request body

Branchstring required

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

ConfigFilestring 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.

RepositoryLinkIdstring 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.

ResourceNamestring 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.

RoleArnstring 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'CFN_STACK_SYNC' required

The type of sync configuration.

PublishDeploymentStatus'ENABLED' | 'DISABLED'

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

TriggerResourceUpdateOn'ANY_CHANGE' | 'FILE_CHANGE'

When to trigger Git sync to begin the stack update.

PullRequestComment'ENABLED' | 'DISABLED'

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

Response

Success