Package software.amazon.awscdk.services.codestarconnections

Class CfnSyncConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codestarconnections.CfnSyncConfiguration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ISyncConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.088Z") @Stability(Stable) public class CfnSyncConfiguration extends CfnResource implements IInspectable, ISyncConfigurationRef
Information, such as repository, branch, provider, and resource names for a specific sync configuration.

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.*;
 CfnSyncConfiguration cfnSyncConfiguration = CfnSyncConfiguration.Builder.create(this, "MyCfnSyncConfiguration")
         .branch("branch")
         .configFile("configFile")
         .repositoryLinkId("repositoryLinkId")
         .resourceName("resourceName")
         .roleArn("roleArn")
         .syncType("syncType")
         // the properties below are optional
         .publishDeploymentStatus("publishDeploymentStatus")
         .triggerResourceUpdateOn("triggerResourceUpdateOn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSyncConfiguration

      protected CfnSyncConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSyncConfiguration

      protected CfnSyncConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSyncConfiguration

      @Stability(Stable) public CfnSyncConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSyncConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

    • getAttrProviderType

      @Stability(Stable) @NotNull public String getAttrProviderType()
      The name of the external provider where your third-party code repository is configured.

    • getAttrRepositoryName

      @Stability(Stable) @NotNull public String getAttrRepositoryName()
      The name of the repository that is being synced to.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSyncConfigurationRef

      @Stability(Stable) @NotNull public SyncConfigurationReference getSyncConfigurationRef()
      A reference to a SyncConfiguration resource.
      Specified by:
      getSyncConfigurationRef in interface ISyncConfigurationRef

    • getBranch

      @Stability(Stable) @NotNull public String getBranch()
      The branch associated with a specific sync configuration.

    • setBranch

      @Stability(Stable) public void setBranch(@NotNull String value)
      The branch associated with a specific sync configuration.

    • getConfigFile

      @Stability(Stable) @NotNull public String getConfigFile()
      The file path to the configuration file associated with a specific sync configuration.

    • setConfigFile

      @Stability(Stable) public void setConfigFile(@NotNull String value)
      The file path to the configuration file associated with a specific sync configuration.

    • getRepositoryLinkId

      @Stability(Stable) @NotNull public String getRepositoryLinkId()
      The ID of the repository link associated with a specific sync configuration.

    • setRepositoryLinkId

      @Stability(Stable) public void setRepositoryLinkId(@NotNull String value)
      The ID of the repository link associated with a specific sync configuration.

    • getResourceName

      @Stability(Stable) @NotNull public String getResourceName()
      The name of the connection resource associated with a specific sync configuration.

    • setResourceName

      @Stability(Stable) public void setResourceName(@NotNull String value)
      The name of the connection resource associated with a specific sync configuration.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

    • getSyncType

      @Stability(Stable) @NotNull public String getSyncType()
      The type of sync for a specific sync configuration.

    • setSyncType

      @Stability(Stable) public void setSyncType(@NotNull String value)
      The type of sync for a specific sync configuration.

    • getPublishDeploymentStatus

      @Stability(Stable) @Nullable public String getPublishDeploymentStatus()
      Whether to enable or disable publishing of deployment status to source providers.

    • setPublishDeploymentStatus

      @Stability(Stable) public void setPublishDeploymentStatus(@Nullable String value)
      Whether to enable or disable publishing of deployment status to source providers.

    • getTriggerResourceUpdateOn

      @Stability(Stable) @Nullable public String getTriggerResourceUpdateOn()
      When to trigger Git sync to begin the stack update.

    • setTriggerResourceUpdateOn

      @Stability(Stable) public void setTriggerResourceUpdateOn(@Nullable String value)
      When to trigger Git sync to begin the stack update.