AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CodeStarConnections::SyncConfiguration

CfnSyncConfiguration

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

Import

import { CfnSyncConfiguration } from 'aws-cdk-lib/aws-codestarconnections';

Or use the module namespace:

import * as codestarconnections from 'aws-cdk-lib/aws-codestarconnections';
// codestarconnections.CfnSyncConfiguration

Properties

Configuration passed to the constructor as CfnSyncConfigurationProps.

branchRequired
string

The branch associated with a specific sync configuration.

configFileRequired
string

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.

repositoryLinkIdRequired
string

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

resourceNameRequired
string

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

roleArnRequired
string

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

syncTypeRequired
string

The type of sync for a specific sync configuration.

publishDeploymentStatusOptional
string

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

triggerResourceUpdateOnOptional
string

When to trigger Git sync to begin the stack update.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CodeStarConnections::SyncConfigurationView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-codestarconnections
CFN TypeAWS::CodeStarConnections::SyncConfiguration
Properties8

Related Constructs

Explore This Service

External Links