Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceRabbitMQBrokerParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceRabbitMQBrokerParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

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

The parameters for using a Rabbit 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.*;
 PipeSourceRabbitMQBrokerParametersProperty pipeSourceRabbitMQBrokerParametersProperty = PipeSourceRabbitMQBrokerParametersProperty.builder()
         .credentials(MQBrokerAccessCredentialsProperty.builder()
                 .basicAuth("basicAuth")
                 .build())
         .queueName("queueName")
         // the properties below are optional
         .batchSize(123)
         .maximumBatchingWindowInSeconds(123)
         .virtualHost("virtualHost")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceRabbitMQBrokerParametersProperty.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.
default String	getVirtualHost()	The name of the virtual host associated with the source broker.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials

getQueueName

@Stability(Stable)
@NotNull
String getQueueName()

The name of the destination queue to consume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename

getBatchSize

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

The maximum number of records to include in each batch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize

getMaximumBatchingWindowInSeconds

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

The maximum length of a time to wait for events.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds

getVirtualHost

@Stability(Stable)
@Nullable
default String getVirtualHost()

The name of the virtual host associated with the source broker.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost

builder

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

Returns:

a CfnPipe.PipeSourceRabbitMQBrokerParametersProperty.Builder of CfnPipe.PipeSourceRabbitMQBrokerParametersProperty