AWS CDK

2.233.0

interface CfnSyncConfigurationMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.CodeStarConnections.Mixins.CfnSyncConfigurationMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodestarconnections/mixins#CfnSyncConfigurationMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.codestarconnections.mixins.CfnSyncConfigurationMixinProps`
Python	`aws_cdk.mixins_preview.aws_codestarconnections.mixins.CfnSyncConfigurationMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_codestarconnections` » `mixins` » `CfnSyncConfigurationMixinProps`

Properties for CfnSyncConfigurationPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as codestarconnections_mixins } from '@aws-cdk/mixins-preview/aws-codestarconnections';
const cfnSyncConfigurationMixinProps: codestarconnections_mixins.CfnSyncConfigurationMixinProps = {
  branch: 'branch',
  configFile: 'configFile',
  publishDeploymentStatus: 'publishDeploymentStatus',
  repositoryLinkId: 'repositoryLinkId',
  resourceName: 'resourceName',
  roleArn: 'roleArn',
  syncType: 'syncType',
  triggerResourceUpdateOn: 'triggerResourceUpdateOn',
};

Properties

Name	Type	Description
branch?	`string`	The branch associated with a specific sync configuration.
configFile?	`string`	The file path to the configuration file associated with a specific sync configuration.
publishDeploymentStatus?	`string`	Whether to enable or disable publishing of deployment status to source providers.
repositoryLinkId?	`string`	The ID of the repository link associated with a specific sync configuration.
resourceName?	`string`	The name of the connection resource associated with a specific sync configuration.
roleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
syncType?	`string`	The type of sync for a specific sync configuration.
triggerResourceUpdateOn?	`string`	When to trigger Git sync to begin the stack update.

branch?

Type: string (optional)

The branch associated with a specific sync configuration.

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

configFile?

Type: string (optional)

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.

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

publishDeploymentStatus?

Type: string (optional)

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

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

repositoryLinkId?

Type: string (optional)

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

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

resourceName?

Type: string (optional)

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

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

roleArn?

Type: string (optional)

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

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

syncType?

Type: string (optional)

The type of sync for a specific sync configuration.

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

triggerResourceUpdateOn?

Type: string (optional)

When to trigger Git sync to begin the stack update.

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

← Previous Next →