Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codestarconnections
  5. SyncConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.codestarconnections.SyncConfiguration

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

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

Create SyncConfiguration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SyncConfiguration(name: string, args: SyncConfigurationArgs, opts?: CustomResourceOptions);
@overload
def SyncConfiguration(resource_name: str,
                      args: SyncConfigurationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def SyncConfiguration(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      branch: Optional[str] = None,
                      config_file: Optional[str] = None,
                      repository_link_id: Optional[str] = None,
                      resource_name_: Optional[str] = None,
                      role_arn: Optional[str] = None,
                      sync_type: Optional[str] = None,
                      publish_deployment_status: Optional[SyncConfigurationPublishDeploymentStatus] = None,
                      trigger_resource_update_on: Optional[SyncConfigurationTriggerResourceUpdateOn] = None)
func NewSyncConfiguration(ctx *Context, name string, args SyncConfigurationArgs, opts ...ResourceOption) (*SyncConfiguration, error)
public SyncConfiguration(string name, SyncConfigurationArgs args, CustomResourceOptions? opts = null)
public SyncConfiguration(String name, SyncConfigurationArgs args)
public SyncConfiguration(String name, SyncConfigurationArgs args, CustomResourceOptions options)

type: aws-native:codestarconnections:SyncConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SyncConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SyncConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SyncConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SyncConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SyncConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SyncConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SyncConfiguration resource accepts the following input properties:

Branch This property is required. string
The name of the branch of the repository from which resources are to be synchronized,
ConfigFile This property is required. string
The source provider repository path of the sync configuration file of the respective SyncType.
RepositoryLinkId This property is required. string
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
ResourceName This property is required. string
The name of the resource that is being synchronized to the repository.
RoleArn This property is required. string
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
SyncType This property is required. string
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
PublishDeploymentStatus Pulumi.AwsNative.CodeStarConnections.SyncConfigurationPublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
TriggerResourceUpdateOn Pulumi.AwsNative.CodeStarConnections.SyncConfigurationTriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
Branch This property is required. string
The name of the branch of the repository from which resources are to be synchronized,
ConfigFile This property is required. string
The source provider repository path of the sync configuration file of the respective SyncType.
RepositoryLinkId This property is required. string
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
ResourceName This property is required. string
The name of the resource that is being synchronized to the repository.
RoleArn This property is required. string
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
SyncType This property is required. string
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
PublishDeploymentStatus SyncConfigurationPublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
TriggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
branch This property is required. String
The name of the branch of the repository from which resources are to be synchronized,
configFile This property is required. String
The source provider repository path of the sync configuration file of the respective SyncType.
repositoryLinkId This property is required. String
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
resourceName This property is required. String
The name of the resource that is being synchronized to the repository.
roleArn This property is required. String
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
syncType This property is required. String
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
publishDeploymentStatus SyncConfigurationPublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
triggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
branch This property is required. string
The name of the branch of the repository from which resources are to be synchronized,
configFile This property is required. string
The source provider repository path of the sync configuration file of the respective SyncType.
repositoryLinkId This property is required. string
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
resourceName This property is required. string
The name of the resource that is being synchronized to the repository.
roleArn This property is required. string
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
syncType This property is required. string
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
publishDeploymentStatus SyncConfigurationPublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
triggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
branch This property is required. str
The name of the branch of the repository from which resources are to be synchronized,
config_file This property is required. str
The source provider repository path of the sync configuration file of the respective SyncType.
repository_link_id This property is required. str
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
resource_name This property is required. str
The name of the resource that is being synchronized to the repository.
role_arn This property is required. str
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
sync_type This property is required. str
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
publish_deployment_status SyncConfigurationPublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
trigger_resource_update_on SyncConfigurationTriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
branch This property is required. String
The name of the branch of the repository from which resources are to be synchronized,
configFile This property is required. String
The source provider repository path of the sync configuration file of the respective SyncType.
repositoryLinkId This property is required. String
A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
resourceName This property is required. String
The name of the resource that is being synchronized to the repository.
roleArn This property is required. String
The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
syncType This property is required. String
The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
publishDeploymentStatus "ENABLED" | "DISABLED"
Whether to enable or disable publishing of deployment status to source providers.
triggerResourceUpdateOn "ANY_CHANGE" | "FILE_CHANGE"
When to trigger Git sync to begin the stack update.

Outputs

All input properties are implicitly available as output properties. Additionally, the SyncConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
the ID of the entity that owns the repository.
ProviderType Pulumi.AwsNative.CodeStarConnections.SyncConfigurationProviderType
The name of the external provider where your third-party code repository is configured.
RepositoryName string
The name of the repository that is being synced to.
Id string
The provider-assigned unique ID for this managed resource.
OwnerId string
the ID of the entity that owns the repository.
ProviderType SyncConfigurationProviderType
The name of the external provider where your third-party code repository is configured.
RepositoryName string
The name of the repository that is being synced to.
id String
The provider-assigned unique ID for this managed resource.
ownerId String
the ID of the entity that owns the repository.
providerType SyncConfigurationProviderType
The name of the external provider where your third-party code repository is configured.
repositoryName String
The name of the repository that is being synced to.
id string
The provider-assigned unique ID for this managed resource.
ownerId string
the ID of the entity that owns the repository.
providerType SyncConfigurationProviderType
The name of the external provider where your third-party code repository is configured.
repositoryName string
The name of the repository that is being synced to.
id str
The provider-assigned unique ID for this managed resource.
owner_id str
the ID of the entity that owns the repository.
provider_type SyncConfigurationProviderType
The name of the external provider where your third-party code repository is configured.
repository_name str
The name of the repository that is being synced to.
id String
The provider-assigned unique ID for this managed resource.
ownerId String
the ID of the entity that owns the repository.
providerType "GitHub" | "Bitbucket" | "GitHubEnterprise" | "GitLab" | "GitLabSelfManaged"
The name of the external provider where your third-party code repository is configured.
repositoryName String
The name of the repository that is being synced to.

Supporting Types

SyncConfigurationProviderType
, SyncConfigurationProviderTypeArgs

GitHub
GitHub
Bitbucket
Bitbucket
GitHubEnterprise
GitHubEnterprise
GitLab
GitLab
GitLabSelfManaged
GitLabSelfManaged
SyncConfigurationProviderTypeGitHub
GitHub
SyncConfigurationProviderTypeBitbucket
Bitbucket
SyncConfigurationProviderTypeGitHubEnterprise
GitHubEnterprise
SyncConfigurationProviderTypeGitLab
GitLab
SyncConfigurationProviderTypeGitLabSelfManaged
GitLabSelfManaged
GitHub
GitHub
Bitbucket
Bitbucket
GitHubEnterprise
GitHubEnterprise
GitLab
GitLab
GitLabSelfManaged
GitLabSelfManaged
GitHub
GitHub
Bitbucket
Bitbucket
GitHubEnterprise
GitHubEnterprise
GitLab
GitLab
GitLabSelfManaged
GitLabSelfManaged
GIT_HUB
GitHub
BITBUCKET
Bitbucket
GIT_HUB_ENTERPRISE
GitHubEnterprise
GIT_LAB
GitLab
GIT_LAB_SELF_MANAGED
GitLabSelfManaged
"GitHub"
GitHub
"Bitbucket"
Bitbucket
"GitHubEnterprise"
GitHubEnterprise
"GitLab"
GitLab
"GitLabSelfManaged"
GitLabSelfManaged

SyncConfigurationPublishDeploymentStatus
, SyncConfigurationPublishDeploymentStatusArgs

Enabled
ENABLED
Disabled
DISABLED
SyncConfigurationPublishDeploymentStatusEnabled
ENABLED
SyncConfigurationPublishDeploymentStatusDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

SyncConfigurationTriggerResourceUpdateOn
, SyncConfigurationTriggerResourceUpdateOnArgs

AnyChange
ANY_CHANGE
FileChange
FILE_CHANGE
SyncConfigurationTriggerResourceUpdateOnAnyChange
ANY_CHANGE
SyncConfigurationTriggerResourceUpdateOnFileChange
FILE_CHANGE
AnyChange
ANY_CHANGE
FileChange
FILE_CHANGE
AnyChange
ANY_CHANGE
FileChange
FILE_CHANGE
ANY_CHANGE
ANY_CHANGE
FILE_CHANGE
FILE_CHANGE
"ANY_CHANGE"
ANY_CHANGE
"FILE_CHANGE"
FILE_CHANGE

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native