sync_configuration

Gets an individual sync_configuration resource

Overview

Name	sync_configuration
Type	Resource
Description	sync_configuration
Id	awscc.codestarconnections.sync_configuration

Fields

Name	Datatype	Description
owner_id	string	the ID of the entity that owns the repository.
resource_name	string	The name of the resource that is being synchronized to the repository.
repository_name	string	The name of the repository that is being synced to.
provider_type	string	The name of the external provider where your third-party code repository is configured.
branch	string	The name of the branch of the repository from which resources are to be synchronized,
config_file	string	The source provider repository path of the sync configuration file of the respective SyncType.
sync_type	string	The type of resource synchronization service that is to be configured, for example, CFN_STACK_SYNC.
role_arn	string	The IAM Role that allows AWS to update CloudFormation stacks based on content in the specified repository.
repository_link_id	string	A UUID that uniquely identifies the RepositoryLink that the SyncConfig is associated with.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
owner_id,
resource_name,
repository_name,
provider_type,
branch,
config_file,
sync_type,
role_arn,
repository_link_id
FROM awscc.codestarconnections.sync_configuration
WHERE data__Identifier = '<ResourceName>|<SyncType>';

Permissions

To operate on the sync_configuration resource, the following permissions are required:

Read

codestar-connections:GetSyncConfiguration

Update

codestar-connections:UpdateSyncConfiguration,
codestar-connections:PassRepository,
iam:PassRole

Delete

codestar-connections:DeleteSyncConfiguration,
codestar-connections:GetSyncConfiguration