Class CfnSyncConfiguration

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSyncConfiguration

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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

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

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(Construct, string, ICfnSyncConfigurationProps)

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

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	Information, such as repository, branch, provider, and resource names for 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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Information, such as repository, branch, provider, and resource names for a specific sync configuration.

Constructors

CfnSyncConfiguration(Construct, string, ICfnSyncConfigurationProps)

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

public CfnSyncConfiguration(Construct scope, string id, ICfnSyncConfigurationProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnSyncConfigurationProps: Resource properties.

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

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

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

string

Remarks

CloudformationAttribute: ProviderType

AttrRepositoryName

The name of the repository that is being synced to.

public virtual string AttrRepositoryName { get; }

Property Value

string

Remarks

CloudformationAttribute: RepositoryName

Branch

The branch associated with a specific sync configuration.

public virtual string Branch { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

ConfigFile

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

public virtual string ConfigFile { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

PublishDeploymentStatus

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

public virtual string? PublishDeploymentStatus { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

RepositoryLinkId

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

public virtual string RepositoryLinkId { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

ResourceName

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

public virtual string ResourceName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

RoleArn

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

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

SyncType

The type of sync for a specific sync configuration.

public virtual string SyncType { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

TriggerResourceUpdateOn

When to trigger Git sync to begin the stack update.

public virtual string? TriggerResourceUpdateOn { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

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.

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::CodeStarConnections::SyncConfiguration

ExampleMetadata: fixture=_generated

Implements

IInspectable