aws_sdk_appflow/client/create_connector_profile.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 [`CreateConnectorProfile`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`connector_profile_name(impl Into<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::connector_profile_name) / [`set_connector_profile_name(Option<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_connector_profile_name):<br>required: **true**<br><p>The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your Amazon Web Services account.</p><br>
7 /// - [`kms_arn(impl Into<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::kms_arn) / [`set_kms_arn(Option<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_kms_arn):<br>required: **false**<br><p>The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.</p><br>
8 /// - [`connector_type(ConnectorType)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::connector_type) / [`set_connector_type(Option<ConnectorType>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_connector_type):<br>required: **true**<br><p>The type of connector, such as Salesforce, Amplitude, and so on.</p><br>
9 /// - [`connector_label(impl Into<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::connector_label) / [`set_connector_label(Option<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_connector_label):<br>required: **false**<br><p>The label of the connector. The label is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.</p><br>
10 /// - [`connection_mode(ConnectionMode)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::connection_mode) / [`set_connection_mode(Option<ConnectionMode>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_connection_mode):<br>required: **true**<br><p>Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.</p><br>
11 /// - [`connector_profile_config(ConnectorProfileConfig)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::connector_profile_config) / [`set_connector_profile_config(Option<ConnectorProfileConfig>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_connector_profile_config):<br>required: **true**<br><p>Defines the connector-specific configuration and credentials.</p><br>
12 /// - [`client_token(impl Into<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::set_client_token):<br>required: **false**<br><p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateConnectorProfile</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p> <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateConnectorProfile</code>. The token is active for 8 hours.</p><br>
13 /// - On success, responds with [`CreateConnectorProfileOutput`](crate::operation::create_connector_profile::CreateConnectorProfileOutput) with field(s):
14 /// - [`connector_profile_arn(Option<String>)`](crate::operation::create_connector_profile::CreateConnectorProfileOutput::connector_profile_arn): <p>The Amazon Resource Name (ARN) of the connector profile.</p>
15 /// - On failure, responds with [`SdkError<CreateConnectorProfileError>`](crate::operation::create_connector_profile::CreateConnectorProfileError)
16 pub fn create_connector_profile(&self) -> crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder {
17 crate::operation::create_connector_profile::builders::CreateConnectorProfileFluentBuilder::new(self.handle.clone())
18 }
19}