Package software.amazon.awscdk.services.codestarconnections

Interface CfnSyncConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSyncConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:17.179Z")
@Stability(Stable)
public interface CfnSyncConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSyncConfiguration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codestarconnections.*;
 CfnSyncConfigurationProps cfnSyncConfigurationProps = CfnSyncConfigurationProps.builder()
         .branch("branch")
         .configFile("configFile")
         .repositoryLinkId("repositoryLinkId")
         .resourceName("resourceName")
         .roleArn("roleArn")
         .syncType("syncType")
         // the properties below are optional
         .publishDeploymentStatus("publishDeploymentStatus")
         .triggerResourceUpdateOn("triggerResourceUpdateOn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSyncConfigurationProps.Builder	A builder for CfnSyncConfigurationProps
static final class	CfnSyncConfigurationProps.Jsii$Proxy	An implementation for CfnSyncConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnSyncConfigurationProps.Builder	builder()
String	getBranch()	The branch associated with a specific sync configuration.
String	getConfigFile()	The file path to the configuration file associated with a specific sync configuration.
default String	getPublishDeploymentStatus()	Whether to enable or disable publishing of deployment status to source providers.
String	getRepositoryLinkId()	The ID of the repository link associated with a specific sync configuration.
String	getResourceName()	The name of the connection resource associated with a specific sync configuration.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
String	getSyncType()	The type of sync for a specific sync configuration.
default String	getTriggerResourceUpdateOn()	When to trigger Git sync to begin the stack update.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBranch

@Stability(Stable)
@NotNull
String getBranch()

The branch associated with a specific sync configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-branch

getConfigFile

@Stability(Stable)
@NotNull
String getConfigFile()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-configfile

getRepositoryLinkId

@Stability(Stable)
@NotNull
String getRepositoryLinkId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-repositorylinkid

getResourceName

@Stability(Stable)
@NotNull
String getResourceName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-resourcename

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-rolearn

getSyncType

@Stability(Stable)
@NotNull
String getSyncType()

The type of sync for a specific sync configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-synctype

getPublishDeploymentStatus

@Stability(Stable)
@Nullable
default String getPublishDeploymentStatus()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-publishdeploymentstatus

getTriggerResourceUpdateOn

@Stability(Stable)
@Nullable
default String getTriggerResourceUpdateOn()

When to trigger Git sync to begin the stack update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-triggerresourceupdateon

builder

@Stability(Stable)
static CfnSyncConfigurationProps.Builder builder()

Returns:

a CfnSyncConfigurationProps.Builder of CfnSyncConfigurationProps