Struct aws_sdk_appflow::operation::create_flow::CreateFlowInput
source · #[non_exhaustive]pub struct CreateFlowInput {
pub flow_name: Option<String>,
pub description: Option<String>,
pub kms_arn: Option<String>,
pub trigger_config: Option<TriggerConfig>,
pub source_flow_config: Option<SourceFlowConfig>,
pub destination_flow_config_list: Option<Vec<DestinationFlowConfig>>,
pub tasks: Option<Vec<Task>>,
pub tags: Option<HashMap<String, String>>,
pub metadata_catalog_config: Option<MetadataCatalogConfig>,
pub client_token: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.flow_name: Option<String>
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
description: Option<String>
A description of the flow you want to create.
kms_arn: Option<String>
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.
trigger_config: Option<TriggerConfig>
The trigger settings that determine how and when the flow runs.
source_flow_config: Option<SourceFlowConfig>
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
destination_flow_config_list: Option<Vec<DestinationFlowConfig>>
The configuration that controls how Amazon AppFlow places data in the destination connector.
tasks: Option<Vec<Task>>
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
The tags used to organize, track, or control access for your flow.
metadata_catalog_config: Option<MetadataCatalogConfig>
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
client_token: Option<String>
The clientToken
parameter is an idempotency token. It ensures that your CreateFlow
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 clientToken
parameter value.
If you omit a clientToken
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.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken
, Amazon AppFlow considers it a new call to CreateFlow
. The token is active for 8 hours.
Implementations§
source§impl CreateFlowInput
impl CreateFlowInput
sourcepub fn flow_name(&self) -> Option<&str>
pub fn flow_name(&self) -> Option<&str>
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the flow you want to create.
sourcepub fn kms_arn(&self) -> Option<&str>
pub fn kms_arn(&self) -> Option<&str>
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.
sourcepub fn trigger_config(&self) -> Option<&TriggerConfig>
pub fn trigger_config(&self) -> Option<&TriggerConfig>
The trigger settings that determine how and when the flow runs.
sourcepub fn source_flow_config(&self) -> Option<&SourceFlowConfig>
pub fn source_flow_config(&self) -> Option<&SourceFlowConfig>
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
sourcepub fn destination_flow_config_list(&self) -> &[DestinationFlowConfig]
pub fn destination_flow_config_list(&self) -> &[DestinationFlowConfig]
The configuration that controls how Amazon AppFlow places data in the destination connector.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destination_flow_config_list.is_none()
.
sourcepub fn tasks(&self) -> &[Task]
pub fn tasks(&self) -> &[Task]
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tasks.is_none()
.
The tags used to organize, track, or control access for your flow.
sourcepub fn metadata_catalog_config(&self) -> Option<&MetadataCatalogConfig>
pub fn metadata_catalog_config(&self) -> Option<&MetadataCatalogConfig>
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
The clientToken
parameter is an idempotency token. It ensures that your CreateFlow
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 clientToken
parameter value.
If you omit a clientToken
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.
If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken
, Amazon AppFlow considers it a new call to CreateFlow
. The token is active for 8 hours.
source§impl CreateFlowInput
impl CreateFlowInput
sourcepub fn builder() -> CreateFlowInputBuilder
pub fn builder() -> CreateFlowInputBuilder
Creates a new builder-style object to manufacture CreateFlowInput
.
Trait Implementations§
source§impl Clone for CreateFlowInput
impl Clone for CreateFlowInput
source§fn clone(&self) -> CreateFlowInput
fn clone(&self) -> CreateFlowInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateFlowInput
impl Debug for CreateFlowInput
source§impl PartialEq for CreateFlowInput
impl PartialEq for CreateFlowInput
source§fn eq(&self, other: &CreateFlowInput) -> bool
fn eq(&self, other: &CreateFlowInput) -> bool
self
and other
values to be equal, and is used
by ==
.