AWS Fundamentals Logo
AWS Fundamentals
AWS::CodeStarConnections::SyncConfiguration

CodeStarConnections SyncConfiguration

Schema for AWS::CodeStarConnections::SyncConfiguration resource which is used to enables an AWS resource to be synchronized from a source-provider.

Properties

8 configurable properties. 6 required. Click a row to see details.

Filter:
PropertyTypeFlags
Branch
string
Required
ConfigFile
string
Required
RepositoryLinkId
string
Required
ResourceName
string
RequiredCreate-only
RoleArn
string
Required
SyncType
string
RequiredCreate-only
PublishDeploymentStatus
string
TriggerResourceUpdateOn
string

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
OwnerIdstringthe ID of the entity that owns the repository.
ProviderTypestringThe name of the external provider where your third-party code repository is configured.
RepositoryNamestringThe name of the repository that is being synced to.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CodeStarConnections::SyncConfiguration

Resources:
  MyResource:
    Type: AWS::CodeStarConnections::SyncConfiguration
    Properties:
      Branch: "value"
      ConfigFile: "value"
      RepositoryLinkId: "my-repositorylinkid"
      ResourceName: "my-resourcename"
      SyncType: "value"
      RoleArn: "arn:aws:service:region:account:resource"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

codestar-connections:CreateSyncConfigurationcodestar-connections:PassRepositoryiam:PassRole

read

codestar-connections:GetSyncConfiguration

update

codestar-connections:UpdateSyncConfigurationcodestar-connections:PassRepositoryiam:PassRole

delete

codestar-connections:DeleteSyncConfigurationcodestar-connections:GetSyncConfiguration

list

codestar-connections:ListSyncConfigurationscodestar-connections:ListRepositoryLinks

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCodeStarConnections
Properties11
Required6
TaggingNot supported
Primary IDResourceName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SyncTypeResourceName

Related Resources

External Links