AWS::CodeStarConnections::SyncConfiguration

Information, such as repository, branch, provider, and resource names for a specific sync configuration.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CodeStarConnections::SyncConfiguration",
  "Properties" : {
      "Branch" : String,
      "ConfigFile" : String,
      "PublishDeploymentStatus" : String,
      "RepositoryLinkId" : String,
      "ResourceName" : String,
      "RoleArn" : String,
      "SyncType" : String,
      "TriggerResourceUpdateOn" : String
    }
}

YAML

Type: AWS::CodeStarConnections::SyncConfiguration
Properties:
  Branch: String
  ConfigFile: String
  PublishDeploymentStatus: String
  RepositoryLinkId: String
  ResourceName: String
  RoleArn: String
  SyncType: String
  TriggerResourceUpdateOn: String

Properties

Branch

The branch associated with a specific sync configuration.

Required: Yes

Type: String

Pattern: ^.*$

Minimum: 1

Maximum: 255

Update requires: No interruption

ConfigFile

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.

Required: Yes

Type: String

Update requires: No interruption

PublishDeploymentStatus

Whether to enable or disable publishing of deployment status to source providers.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

RepositoryLinkId

The ID of the repository link associated with a specific sync configuration.

Required: Yes

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Update requires: No interruption

ResourceName

The name of the connection resource associated with a specific sync configuration.

Required: Yes

Type: String

Pattern: [a-za-z0-9_\.-]+

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

Required: Yes

Type: String

Pattern: arn:aws(-[\w]+)*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Minimum: 1

Maximum: 1024

Update requires: No interruption

SyncType

The type of sync for a specific sync configuration.

Required: Yes

Type: String

Allowed values: CFN_STACK_SYNC

Update requires: Replacement

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

Required: No

Type: String

Allowed values: ANY_CHANGE | FILE_CHANGE

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the sync configuration.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

OwnerId

The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

ProviderType

Property description not available.

RepositoryName

Property description not available.