Interface ICfnSyncConfigurationProps

Properties for defining a CfnSyncConfiguration.

Namespace: Amazon.CDK.AWS.CodeStarConnections

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnSyncConfigurationProps

Syntax (vb)

Public Interface ICfnSyncConfigurationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeStarConnections;

             var cfnSyncConfigurationProps = new CfnSyncConfigurationProps {
                 Branch = "branch",
                 ConfigFile = "configFile",
                 RepositoryLinkId = "repositoryLinkId",
                 ResourceName = "resourceName",
                 RoleArn = "roleArn",
                 SyncType = "syncType",

                 // the properties below are optional
                 PublishDeploymentStatus = "publishDeploymentStatus",
                 TriggerResourceUpdateOn = "triggerResourceUpdateOn"
             };

Synopsis

Properties

Branch	The branch associated with a specific sync configuration.
ConfigFile	The file path to the configuration file associated with a specific sync configuration.
PublishDeploymentStatus	Whether to enable or disable publishing of deployment status to source providers.
RepositoryLinkId	The ID of the repository link associated with a specific sync configuration.
ResourceName	The name of the connection resource associated with a specific sync configuration.
RoleArn	The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
SyncType	The type of sync for a specific sync configuration.
TriggerResourceUpdateOn	When to trigger Git sync to begin the stack update.

Properties

Branch

The branch associated with a specific sync configuration.

string Branch { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-branch

ConfigFile

The file path to the configuration file associated with a specific sync configuration.

string ConfigFile { get; }

Property Value

string

Remarks

The path should point to an actual file in the sync configurations linked repository.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-configfile

PublishDeploymentStatus

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

string? PublishDeploymentStatus { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-publishdeploymentstatus

RepositoryLinkId

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

string RepositoryLinkId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-repositorylinkid

ResourceName

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

string ResourceName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-resourcename

RoleArn

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

string RoleArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-rolearn

SyncType

The type of sync for a specific sync configuration.

string SyncType { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-synctype

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

string? TriggerResourceUpdateOn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-triggerresourceupdateon