aws_sdk_codestarconnections/client/
create_sync_configuration.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateSyncConfiguration`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`branch(impl Into<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::branch) / [`set_branch(Option<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_branch):<br>required: **true**<br><p>The branch in the repository from which changes will be synced.</p><br>
7    ///   - [`config_file(impl Into<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::config_file) / [`set_config_file(Option<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_config_file):<br>required: **true**<br><p>The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.</p><br>
8    ///   - [`repository_link_id(impl Into<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::repository_link_id) / [`set_repository_link_id(Option<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_repository_link_id):<br>required: **true**<br><p>The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.</p><br>
9    ///   - [`resource_name(impl Into<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::resource_name) / [`set_resource_name(Option<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_resource_name):<br>required: **true**<br><p>The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.</p><br>
10    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_role_arn):<br>required: **true**<br><p>The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.</p><br>
11    ///   - [`sync_type(SyncConfigurationType)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::sync_type) / [`set_sync_type(Option<SyncConfigurationType>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_sync_type):<br>required: **true**<br><p>The type of sync configuration.</p><br>
12    ///   - [`publish_deployment_status(PublishDeploymentStatus)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::publish_deployment_status) / [`set_publish_deployment_status(Option<PublishDeploymentStatus>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_publish_deployment_status):<br>required: **false**<br><p>Whether to enable or disable publishing of deployment status to source providers.</p><br>
13    ///   - [`trigger_resource_update_on(TriggerResourceUpdateOn)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::trigger_resource_update_on) / [`set_trigger_resource_update_on(Option<TriggerResourceUpdateOn>)`](crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::set_trigger_resource_update_on):<br>required: **false**<br><p>When to trigger Git sync to begin the stack update.</p><br>
14    /// - On success, responds with [`CreateSyncConfigurationOutput`](crate::operation::create_sync_configuration::CreateSyncConfigurationOutput) with field(s):
15    ///   - [`sync_configuration(Option<SyncConfiguration>)`](crate::operation::create_sync_configuration::CreateSyncConfigurationOutput::sync_configuration): <p>The created sync configuration for the connection. A sync configuration allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.</p>
16    /// - On failure, responds with [`SdkError<CreateSyncConfigurationError>`](crate::operation::create_sync_configuration::CreateSyncConfigurationError)
17    pub fn create_sync_configuration(&self) -> crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder {
18        crate::operation::create_sync_configuration::builders::CreateSyncConfigurationFluentBuilder::new(self.handle.clone())
19    }
20}