interface CfnSyncConfigurationProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeStarConnections.CfnSyncConfigurationProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodestarconnections#CfnSyncConfigurationProps |
![]() | software.amazon.awscdk.services.codestarconnections.CfnSyncConfigurationProps |
![]() | aws_cdk.aws_codestarconnections.CfnSyncConfigurationProps |
![]() | aws-cdk-lib » aws_codestarconnections » CfnSyncConfigurationProps |
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 { aws_codestarconnections as codestarconnections } from 'aws-cdk-lib';
const cfnSyncConfigurationProps: codestarconnections.CfnSyncConfigurationProps = {
branch: 'branch',
configFile: 'configFile',
repositoryLinkId: 'repositoryLinkId',
resourceName: 'resourceName',
roleArn: 'roleArn',
syncType: 'syncType',
// the properties below are optional
publishDeploymentStatus: 'publishDeploymentStatus',
triggerResourceUpdateOn: 'triggerResourceUpdateOn',
};
Properties
Name | Type | Description |
---|---|---|
branch | string | The branch associated with a specific sync configuration. |
config | string | The file path to the configuration file associated with a specific sync configuration. |
repository | string | The ID of the repository link associated with a specific sync configuration. |
resource | string | The name of the connection resource associated with a specific sync configuration. |
role | string | The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration. |
sync | string | The type of sync for a specific sync configuration. |
publish | string | Whether to enable or disable publishing of deployment status to source providers. |
trigger | string | When to trigger Git sync to begin the stack update. |
branch
Type:
string
The branch associated with a specific sync configuration.
configFile
Type:
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.
repositoryLinkId
Type:
string
The ID of the repository link associated with a specific sync configuration.
resourceName
Type:
string
The name of the connection resource associated with a specific sync configuration.
roleArn
Type:
string
The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
syncType
Type:
string
The type of sync for a specific sync configuration.
publishDeploymentStatus?
Type:
string
(optional)
Whether to enable or disable publishing of deployment status to source providers.
triggerResourceUpdateOn?
Type:
string
(optional)
When to trigger Git sync to begin the stack update.