Package software.amazon.awscdk.services.pipes.alpha

Class PipeProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • source

      @Stability(Experimental) public PipeProps.Builder source(ISource source)
      Sets the value of PipeProps.getSource()
      Parameters:
      source - The source of the pipe. This parameter is required.
      Returns:
      this

    • target

      @Stability(Experimental) public PipeProps.Builder target(ITarget target)
      Sets the value of PipeProps.getTarget()
      Parameters:
      target - The target of the pipe. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public PipeProps.Builder description(String description)
      Sets the value of PipeProps.getDescription()
      Parameters:
      description - A description of the pipe displayed in the AWS console.
      Returns:
      this

    • desiredState

      @Stability(Experimental) public PipeProps.Builder desiredState(DesiredState desiredState)
      Sets the value of PipeProps.getDesiredState()
      Parameters:
      desiredState - The desired state of the pipe. If the state is set to STOPPED, the pipe will not process events.
      Returns:
      this

    • enrichment

      @Stability(Experimental) public PipeProps.Builder enrichment(IEnrichment enrichment)
      Sets the value of PipeProps.getEnrichment()
      Parameters:
      enrichment - Enrichment step to enhance the data from the source before sending it to the target.
      Returns:
      this

    • filter

      @Stability(Experimental) public PipeProps.Builder filter(IFilter filter)
      Sets the value of PipeProps.getFilter()
      Parameters:
      filter - The filter pattern for the pipe source.
      Returns:
      this

    • kmsKey

      @Stability(Experimental) public PipeProps.Builder kmsKey(IKey kmsKey)
      Sets the value of PipeProps.getKmsKey()
      Parameters:
      kmsKey - The AWS KMS customer managed key to encrypt pipe data.
      Returns:
      this

    • logDestinations

      @Stability(Experimental) public PipeProps.Builder logDestinations(List<? extends ILogDestination> logDestinations)
      Sets the value of PipeProps.getLogDestinations()
      Parameters:
      logDestinations - Destinations for the logs.
      Returns:
      this

    • logIncludeExecutionData

      @Stability(Experimental) public PipeProps.Builder logIncludeExecutionData(List<? extends IncludeExecutionData> logIncludeExecutionData)
      Sets the value of PipeProps.getLogIncludeExecutionData()
      Parameters:
      logIncludeExecutionData - Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe. This applies to all log destinations for the pipe.

      For more information, see Including execution data in logs and the message schema in the Amazon EventBridge User Guide .

      Returns:
      this

    • logLevel

      @Stability(Experimental) public PipeProps.Builder logLevel(LogLevel logLevel)
      Sets the value of PipeProps.getLogLevel()
      Parameters:
      logLevel - The level of logging detail to include. This applies to all log destinations for the pipe.
      Returns:
      this

    • pipeName

      @Stability(Experimental) public PipeProps.Builder pipeName(String pipeName)
      Sets the value of PipeProps.getPipeName()
      Parameters:
      pipeName - Name of the pipe in the AWS console.
      Returns:
      this

    • role

      @Stability(Experimental) public PipeProps.Builder role(IRole role)
      Sets the value of PipeProps.getRole()
      Parameters:
      role - The role used by the pipe which has permissions to read from the source and write to the target. If an enriched target is used, the role also have permissions to call the enriched target. If no role is provided, a role will be created.
      Returns:
      this

    • tags

      @Stability(Experimental) public PipeProps.Builder tags(Map<String,String> tags)
      Sets the value of PipeProps.getTags()
      Parameters:
      tags - The list of key-value pairs to associate with the pipe.
      Returns:
      this

    • build

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