Package software.amazon.awscdk.cfnpropertymixins.services.pipes

Interface CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipePropsMixin

@Stability(Stable)
public static interface CfnPipePropsMixin.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.cfnpropertymixins.services.pipes.*;
 PipeSourceRabbitMQBrokerParametersProperty pipeSourceRabbitMQBrokerParametersProperty = PipeSourceRabbitMQBrokerParametersProperty.builder()
         .batchSize(123)
         .credentials(MQBrokerAccessCredentialsProperty.builder()
                 .basicAuth("basicAuth")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .queueName("queueName")
         .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	CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Builder	A builder for CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty
static final class	CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Jsii$Proxy	An implementation for CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Builder	builder()
default Number	getBatchSize()	The maximum number of records to include in each batch.
default Object	getCredentials()	The credentials needed to access the resource.
default Number	getMaximumBatchingWindowInSeconds()	The maximum length of a time to wait for events.
default 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

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

getCredentials

@Stability(Stable)
@Nullable
default Object getCredentials()

The credentials needed to access the resource.

Returns union: either IResolvable or CfnPipePropsMixin.MQBrokerAccessCredentialsProperty

See Also:

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

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

getQueueName

@Stability(Stable)
@Nullable
default 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

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 CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Builder builder()

Returns:

a CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty.Builder of CfnPipePropsMixin.PipeSourceRabbitMQBrokerParametersProperty