Package software.amazon.awscdk.services.appflow

Class CfnFlowProps.Builder

java.lang.Object
software.amazon.awscdk.services.appflow.CfnFlowProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFlowProps>
Enclosing interface:
CfnFlowProps
@Stability(Stable) public static final class CfnFlowProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFlowProps>
A builder for CfnFlowProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • destinationFlowConfigList

      @Stability(Stable) public CfnFlowProps.Builder destinationFlowConfigList(IResolvable destinationFlowConfigList)
      Sets the value of CfnFlowProps.getDestinationFlowConfigList()
      Parameters:
      destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector. This parameter is required.
      Returns:
      this

    • destinationFlowConfigList

      @Stability(Stable) public CfnFlowProps.Builder destinationFlowConfigList(List<? extends Object> destinationFlowConfigList)
      Sets the value of CfnFlowProps.getDestinationFlowConfigList()
      Parameters:
      destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector. This parameter is required.
      Returns:
      this

    • flowName

      @Stability(Stable) public CfnFlowProps.Builder flowName(String flowName)
      Sets the value of CfnFlowProps.getFlowName()
      Parameters:
      flowName - The specified name of the flow. This parameter is required. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
      Returns:
      this

    • sourceFlowConfig

      @Stability(Stable) public CfnFlowProps.Builder sourceFlowConfig(IResolvable sourceFlowConfig)
      Sets the value of CfnFlowProps.getSourceFlowConfig()
      Parameters:
      sourceFlowConfig - Contains information about the configuration of the source connector used in the flow. This parameter is required.
      Returns:
      this

    • sourceFlowConfig

      @Stability(Stable) public CfnFlowProps.Builder sourceFlowConfig(CfnFlow.SourceFlowConfigProperty sourceFlowConfig)
      Sets the value of CfnFlowProps.getSourceFlowConfig()
      Parameters:
      sourceFlowConfig - Contains information about the configuration of the source connector used in the flow. This parameter is required.
      Returns:
      this

    • tasks

      @Stability(Stable) public CfnFlowProps.Builder tasks(IResolvable tasks)
      Sets the value of CfnFlowProps.getTasks()
      Parameters:
      tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. This parameter is required.
      Returns:
      this

    • tasks

      @Stability(Stable) public CfnFlowProps.Builder tasks(List<? extends Object> tasks)
      Sets the value of CfnFlowProps.getTasks()
      Parameters:
      tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. This parameter is required.
      Returns:
      this

    • triggerConfig

      @Stability(Stable) public CfnFlowProps.Builder triggerConfig(IResolvable triggerConfig)
      Sets the value of CfnFlowProps.getTriggerConfig()
      Parameters:
      triggerConfig - The trigger settings that determine how and when Amazon AppFlow runs the specified flow. This parameter is required.
      Returns:
      this

    • triggerConfig

      @Stability(Stable) public CfnFlowProps.Builder triggerConfig(CfnFlow.TriggerConfigProperty triggerConfig)
      Sets the value of CfnFlowProps.getTriggerConfig()
      Parameters:
      triggerConfig - The trigger settings that determine how and when Amazon AppFlow runs the specified flow. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnFlowProps.Builder description(String description)
      Sets the value of CfnFlowProps.getDescription()
      Parameters:
      description - A user-entered description of the flow.
      Returns:
      this

    • flowStatus

      @Stability(Stable) public CfnFlowProps.Builder flowStatus(String flowStatus)
      Sets the value of CfnFlowProps.getFlowStatus()
      Parameters:
      flowStatus - Sets the status of the flow. You can specify one of the following values:.
      • Active - The flow runs based on the trigger settings that you defined. Active scheduled flows run as scheduled, and active event-triggered flows run when the specified change event occurs. However, active on-demand flows run only when you manually start them by using Amazon AppFlow.
      • Suspended - You can use this option to deactivate an active flow. Scheduled and event-triggered flows will cease to run until you reactive them. This value only affects scheduled and event-triggered flows. It has no effect for on-demand flows.

      If you omit the FlowStatus parameter, Amazon AppFlow creates the flow with a default status. The default status for on-demand flows is Active. The default status for scheduled and event-triggered flows is Draft, which means they’re not yet active.

      Returns:
      this

    • kmsArn

      @Stability(Stable) public CfnFlowProps.Builder kmsArn(String kmsArn)
      Sets the value of CfnFlowProps.getKmsArn()
      Parameters:
      kmsArn - 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.
      Returns:
      this

    • metadataCatalogConfig

      @Stability(Stable) public CfnFlowProps.Builder metadataCatalogConfig(IResolvable metadataCatalogConfig)
      Sets the value of CfnFlowProps.getMetadataCatalogConfig()
      Parameters:
      metadataCatalogConfig - Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.
      Returns:
      this

    • metadataCatalogConfig

      @Stability(Stable) public CfnFlowProps.Builder metadataCatalogConfig(CfnFlow.MetadataCatalogConfigProperty metadataCatalogConfig)
      Sets the value of CfnFlowProps.getMetadataCatalogConfig()
      Parameters:
      metadataCatalogConfig - Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnFlowProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnFlowProps.getTags()
      Parameters:
      tags - The tags used to organize, track, or control access for your flow.
      Returns:
      this

    • build

      @Stability(Stable) public CfnFlowProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFlowProps>
      Returns:
      a new instance of CfnFlowProps
      Throws:
      NullPointerException - if any required attribute was not provided