SyncConfiguration - AWS CodeConnections

SyncConfiguration

Information, such as repository, branch, provider, and resource names for a specific sync configuration.

Contents

Branch

The branch associated with a specific sync configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^.*$

Required: Yes

OwnerId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^.*$

Required: Yes

ProviderType

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

Type: String

Valid Values: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged

Required: Yes

RepositoryLinkId

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

Type: String

Pattern: ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

Required: Yes

RepositoryName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^.*$

Required: Yes

ResourceName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: arn:aws(-[\w]+)*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

SyncType

The type of sync for a specific sync configuration.

Type: String

Valid Values: CFN_STACK_SYNC

Required: Yes

ConfigFile

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.

Type: String

Required: No

PublishDeploymentStatus

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

PullRequestComment

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

Type: String

Valid Values: ENABLED | DISABLED

Required: No

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

Type: String

Valid Values: ANY_CHANGE | FILE_CHANGE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: