Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceActiveMQBrokerParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeSourceActiveMQBrokerParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using an Active MQ broker as a source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeSourceActiveMQBrokerParametersProperty pipeSourceActiveMQBrokerParametersProperty = PipeSourceActiveMQBrokerParametersProperty.builder()
         .credentials(MQBrokerAccessCredentialsProperty.builder()
                 .basicAuth("basicAuth")
                 .build())
         .queueName("queueName")
         // the properties below are optional
         .batchSize(123)
         .maximumBatchingWindowInSeconds(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Builder	A builder for CfnPipe.PipeSourceActiveMQBrokerParametersProperty
static final class	CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeSourceActiveMQBrokerParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Builder	builder()
default Number	getBatchSize()	The maximum number of records to include in each batch.
Object	getCredentials()	The credentials needed to access the resource.
default Number	getMaximumBatchingWindowInSeconds()	The maximum length of a time to wait for events.
String	getQueueName()	The name of the destination queue to consume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentials

@Stability(Stable)
@NotNull
Object getCredentials()

The credentials needed to access the resource.

getQueueName

@Stability(Stable)
@NotNull
String getQueueName()

The name of the destination queue to consume.

getBatchSize

@Stability(Stable)
@Nullable
default Number getBatchSize()

The maximum number of records to include in each batch.

getMaximumBatchingWindowInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumBatchingWindowInSeconds()

The maximum length of a time to wait for events.

builder

@Stability(Stable)
static CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeSourceActiveMQBrokerParametersProperty.Builder of CfnPipe.PipeSourceActiveMQBrokerParametersProperty