CfnSyncConfigurationProps

class aws_cdk.aws_codestarconnections.CfnSyncConfigurationProps(*, branch, config_file, repository_link_id, resource_name, role_arn, sync_type, publish_deployment_status=None, trigger_resource_update_on=None)

Bases: object

Properties for defining a CfnSyncConfiguration.

Parameters:

• branch (str) – The branch associated with a specific sync configuration.

• config_file (str) – 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.

• repository_link_id (str) – The ID of the repository link associated with a specific sync configuration.

• resource_name (str) – The name of the connection resource associated with a specific sync configuration.

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

• sync_type (str) – The type of sync for a specific sync configuration.

• publish_deployment_status (Optional[str]) – Whether to enable or disable publishing of deployment status to source providers.

• trigger_resource_update_on (Optional[str]) – When to trigger Git sync to begin the stack update.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codestarconnections as codestarconnections

cfn_sync_configuration_props = codestarconnections.CfnSyncConfigurationProps(
    branch="branch",
    config_file="configFile",
    repository_link_id="repositoryLinkId",
    resource_name="resourceName",
    role_arn="roleArn",
    sync_type="syncType",

    # the properties below are optional
    publish_deployment_status="publishDeploymentStatus",
    trigger_resource_update_on="triggerResourceUpdateOn"
)

Attributes

branch

The branch associated with a specific sync configuration.

See:

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

config_file

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:

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

publish_deployment_status

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

See:

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

repository_link_id

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

See:

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

resource_name

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

See:

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

role_arn

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

See:

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

sync_type

The type of sync for a specific sync configuration.

See:

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

trigger_resource_update_on

When to trigger Git sync to begin the stack update.

See:

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