Class CfnSyncConfiguration
Information, such as repository, branch, provider, and resource names for a specific sync configuration.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CodeStarConnections
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSyncConfiguration : CfnResource, IInspectable
Syntax (vb)
Public Class CfnSyncConfiguration
Inherits CfnResource
Implements IInspectable
Remarks
CloudformationResource: AWS::CodeStarConnections::SyncConfiguration
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 cfnSyncConfiguration = new CfnSyncConfiguration(this, "MyCfnSyncConfiguration", new CfnSyncConfigurationProps {
Branch = "branch",
ConfigFile = "configFile",
RepositoryLinkId = "repositoryLinkId",
ResourceName = "resourceName",
RoleArn = "roleArn",
SyncType = "syncType",
// the properties below are optional
PublishDeploymentStatus = "publishDeploymentStatus",
TriggerResourceUpdateOn = "triggerResourceUpdateOn"
});
Synopsis
Constructors
CfnSyncConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSyncConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSyncConfiguration(Construct, String, ICfnSyncConfigurationProps) |
Properties
AttrOwnerId | The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub. |
AttrProviderType | The name of the external provider where your third-party code repository is configured. |
AttrRepositoryName | The name of the repository that is being synced to. |
Branch | The branch associated with a specific sync configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSyncConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSyncConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSyncConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSyncConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSyncConfiguration(Construct, String, ICfnSyncConfigurationProps)
public CfnSyncConfiguration(Construct scope, string id, ICfnSyncConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSyncConfigurationProps
Resource properties.
Properties
AttrOwnerId
The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
public virtual string AttrOwnerId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: OwnerId
AttrProviderType
The name of the external provider where your third-party code repository is configured.
public virtual string AttrProviderType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProviderType
AttrRepositoryName
The name of the repository that is being synced to.
public virtual string AttrRepositoryName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RepositoryName
Branch
The branch associated with a specific sync configuration.
public virtual string Branch { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigFile
The file path to the configuration file associated with a specific sync configuration.
public virtual string ConfigFile { get; set; }
Property Value
System.String
PublishDeploymentStatus
Whether to enable or disable publishing of deployment status to source providers.
public virtual string PublishDeploymentStatus { get; set; }
Property Value
System.String
RepositoryLinkId
The ID of the repository link associated with a specific sync configuration.
public virtual string RepositoryLinkId { get; set; }
Property Value
System.String
ResourceName
The name of the connection resource associated with a specific sync configuration.
public virtual string ResourceName { get; set; }
Property Value
System.String
RoleArn
The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
public virtual string RoleArn { get; set; }
Property Value
System.String
SyncType
The type of sync for a specific sync configuration.
public virtual string SyncType { get; set; }
Property Value
System.String
TriggerResourceUpdateOn
When to trigger Git sync to begin the stack update.
public virtual string TriggerResourceUpdateOn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>