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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.codestarconnections.getSyncConfiguration

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 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.

    Using getSyncConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSyncConfiguration(args: GetSyncConfigurationArgs, opts?: InvokeOptions): Promise<GetSyncConfigurationResult>
function getSyncConfigurationOutput(args: GetSyncConfigurationOutputArgs, opts?: InvokeOptions): Output<GetSyncConfigurationResult>
    def get_sync_configuration(resource_name: Optional[str] = None,
                           sync_type: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSyncConfigurationResult
def get_sync_configuration_output(resource_name: Optional[pulumi.Input[str]] = None,
                           sync_type: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSyncConfigurationResult]
    func LookupSyncConfiguration(ctx *Context, args *LookupSyncConfigurationArgs, opts ...InvokeOption) (*LookupSyncConfigurationResult, error)
func LookupSyncConfigurationOutput(ctx *Context, args *LookupSyncConfigurationOutputArgs, opts ...InvokeOption) LookupSyncConfigurationResultOutput

    > Note: This function is named LookupSyncConfiguration in the Go SDK.

    public static class GetSyncConfiguration 
{
    public static Task<GetSyncConfigurationResult> InvokeAsync(GetSyncConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncConfigurationResult> Invoke(GetSyncConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSyncConfigurationResult> getSyncConfiguration(GetSyncConfigurationArgs args, InvokeOptions options)
public static Output<GetSyncConfigurationResult> getSyncConfiguration(GetSyncConfigurationArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:codestarconnections:getSyncConfiguration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceName string
    The name of the resource that is being synchronized to the repository.
    SyncType string
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
    ResourceName string
    The name of the resource that is being synchronized to the repository.
    SyncType string
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
    resourceName String
    The name of the resource that is being synchronized to the repository.
    syncType String
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
    resourceName string
    The name of the resource that is being synchronized to the repository.
    syncType string
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
    resource_name str
    The name of the resource that is being synchronized to the repository.
    sync_type str
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
    resourceName String
    The name of the resource that is being synchronized to the repository.
    syncType String
    The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.

    getSyncConfiguration Result

    The following output properties are available:

    Branch string
    The name of the branch of the repository from which resources are to be synchronized,
    ConfigFile string
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    PublishDeploymentStatus Pulumi.AwsNative.CodeStarConnections.SyncConfigurationPublishDeploymentStatus
    Whether to enable or disable publishing of deployment status to source providers.
    RepositoryLinkId string
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    RepositoryName string
    The name of the repository that is being synced to.
    RoleArn string
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    TriggerResourceUpdateOn Pulumi.AwsNative.CodeStarConnections.SyncConfigurationTriggerResourceUpdateOn
    When to trigger Git sync to begin the stack update.
    Branch string
    The name of the branch of the repository from which resources are to be synchronized,
    ConfigFile string
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    PublishDeploymentStatus SyncConfigurationPublishDeploymentStatus
    Whether to enable or disable publishing of deployment status to source providers.
    RepositoryLinkId string
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    RepositoryName string
    The name of the repository that is being synced to.
    RoleArn string
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    TriggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
    When to trigger Git sync to begin the stack update.
    branch String
    The name of the branch of the repository from which resources are to be synchronized,
    configFile String
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    publishDeploymentStatus SyncConfigurationPublishDeploymentStatus
    Whether to enable or disable publishing of deployment status to source providers.
    repositoryLinkId String
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    repositoryName String
    The name of the repository that is being synced to.
    roleArn String
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    triggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
    When to trigger Git sync to begin the stack update.
    branch string
    The name of the branch of the repository from which resources are to be synchronized,
    configFile string
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    publishDeploymentStatus SyncConfigurationPublishDeploymentStatus
    Whether to enable or disable publishing of deployment status to source providers.
    repositoryLinkId string
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    repositoryName string
    The name of the repository that is being synced to.
    roleArn string
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    triggerResourceUpdateOn SyncConfigurationTriggerResourceUpdateOn
    When to trigger Git sync to begin the stack update.
    branch str
    The name of the branch of the repository from which resources are to be synchronized,
    config_file str
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    publish_deployment_status SyncConfigurationPublishDeploymentStatus
    Whether to enable or disable publishing of deployment status to source providers.
    repository_link_id str
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    repository_name str
    The name of the repository that is being synced to.
    role_arn str
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    trigger_resource_update_on SyncConfigurationTriggerResourceUpdateOn
    When to trigger Git sync to begin the stack update.
    branch String
    The name of the branch of the repository from which resources are to be synchronized,
    configFile String
    The source provider repository path of the sync configuration file of the respective SyncType.
    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.
    publishDeploymentStatus "ENABLED" | "DISABLED"
    Whether to enable or disable publishing of deployment status to source providers.
    repositoryLinkId String
    A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
    repositoryName String
    The name of the repository that is being synced to.
    roleArn String
    The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
    triggerResourceUpdateOn "ANY_CHANGE" | "FILE_CHANGE"
    When to trigger Git sync to begin the stack update.

    Supporting Types

    SyncConfigurationProviderType

    SyncConfigurationPublishDeploymentStatus

    SyncConfigurationTriggerResourceUpdateOn

    Package Details

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

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native