# API Reference ## Constructs ### ActiveMqBrokerConfiguration #### Initializers ```typescript import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerConfiguration(scope: Construct, id: string, props: ActiveMqBrokerConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ActiveMqBrokerConfigurationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ActiveMqBrokerConfigurationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | associateWith | *No description.* | | createRevision | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `associateWith` ```typescript public associateWith(broker: IActiveMqBrokerDeployment): ConfigurationAssociation ``` ###### `broker`^Required - *Type:* IActiveMqBrokerDeployment --- ##### `createRevision` ```typescript public createRevision(options: ActiveMqBrokerConfigurationOptions): IActiveMqBrokerConfiguration ``` ###### `options`^Required - *Type:* ActiveMqBrokerConfigurationOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromAttributes | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerConfiguration.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerConfiguration.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAttributes` ```typescript import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerConfiguration.fromAttributes(scope: Construct, logicalId: string, attrs: BrokerConfigurationAttributes) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* BrokerConfigurationAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### ActiveMqBrokerDeploymentBase - *Implements:* IActiveMqBrokerDeployment #### Initializers ```typescript import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerDeploymentBase(scope: Construct, id: string, props: ActiveMqBrokerDeploymentBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ActiveMqBrokerDeploymentBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ActiveMqBrokerDeploymentBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAmqpMaximumConnections | *No description.* | | metricBurstBalance | *No description.* | | metricConsumerCount | *No description.* | | metricCpuCreditBalance | *No description.* | | metricCpuUtilization | *No description.* | | metricCurrentConnectionsCount | *No description.* | | metricDequeueCount | *No description.* | | metricDispatchCount | *No description.* | | metricEnqueueCount | *No description.* | | metricEnqueueTime | *No description.* | | metricEstablishedConnectionsCount | *No description.* | | metricExpiredCount | *No description.* | | metricHeapUsage | *No description.* | | metricInactiveDurableTopicSubscribersCount | *No description.* | | metricInFlightCount | *No description.* | | metricJobSchedulerStorePercentUsage | *No description.* | | metricJournalFilesForFastRecovery | *No description.* | | metricJournalFilesForFullRecovery | *No description.* | | metricMemoryUsage | *No description.* | | metricMqttMaximumConnections | *No description.* | | metricNetworkConnectorConnectionCount | *No description.* | | metricNetworkIn | *No description.* | | metricNetworkOut | *No description.* | | metricOpenTransactionCount | *No description.* | | metricOpenwireMaximumConnections | *No description.* | | metricProducerCount | *No description.* | | metricQueueSize | *No description.* | | metricReceiveCount | *No description.* | | metricStompMaximumConnections | *No description.* | | metricStorePercentUsage | *No description.* | | metricTempPercentUsage | *No description.* | | metricTotalConsumerCount | *No description.* | | metricTotalDequeueCount | *No description.* | | metricTotalEnqueueCount | *No description.* | | metricTotalMessageCount | *No description.* | | metricTotalProducerCount | *No description.* | | metricVolumeReadOps | *No description.* | | metricVolumeWriteOps | *No description.* | | metricWsMaximumConnections | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAmqpMaximumConnections` ```typescript public metricAmqpMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBurstBalance` ```typescript public metricBurstBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuCreditBalance` ```typescript public metricCpuCreditBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuUtilization` ```typescript public metricCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCurrentConnectionsCount` ```typescript public metricCurrentConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDequeueCount` ```typescript public metricDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDispatchCount` ```typescript public metricDispatchCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueCount` ```typescript public metricEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueTime` ```typescript public metricEnqueueTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEstablishedConnectionsCount` ```typescript public metricEstablishedConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExpiredCount` ```typescript public metricExpiredCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricHeapUsage` ```typescript public metricHeapUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInactiveDurableTopicSubscribersCount` ```typescript public metricInactiveDurableTopicSubscribersCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInFlightCount` ```typescript public metricInFlightCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJobSchedulerStorePercentUsage` ```typescript public metricJobSchedulerStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFastRecovery` ```typescript public metricJournalFilesForFastRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFullRecovery` ```typescript public metricJournalFilesForFullRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMemoryUsage` ```typescript public metricMemoryUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMqttMaximumConnections` ```typescript public metricMqttMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkConnectorConnectionCount` ```typescript public metricNetworkConnectorConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkIn` ```typescript public metricNetworkIn(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkOut` ```typescript public metricNetworkOut(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenTransactionCount` ```typescript public metricOpenTransactionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenwireMaximumConnections` ```typescript public metricOpenwireMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricProducerCount` ```typescript public metricProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueSize` ```typescript public metricQueueSize(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricReceiveCount` ```typescript public metricReceiveCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStompMaximumConnections` ```typescript public metricStompMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStorePercentUsage` ```typescript public metricStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTempPercentUsage` ```typescript public metricTempPercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalConsumerCount` ```typescript public metricTotalConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalDequeueCount` ```typescript public metricTotalDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalEnqueueCount` ```typescript public metricTotalEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalMessageCount` ```typescript public metricTotalMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalProducerCount` ```typescript public metricTotalProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeReadOps` ```typescript public metricVolumeReadOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeWriteOps` ```typescript public metricVolumeWriteOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricWsMaximumConnections` ```typescript public metricWsMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerDeploymentBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerDeploymentBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerDeploymentBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | configuration | IActiveMqBrokerConfiguration | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `configuration`^Required ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration --- ### ActiveMqBrokerInstance - *Implements:* IActiveMqBrokerInstance A representation of a single-instance broker comprised of one broker in one Availability Zone. Additional optimizations: - When subnet selection returns more then 1 subnets. A first one is picked. Warning is annotated see: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/single-broker-deployment.html #### Initializers ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerInstance(scope: Construct, id: string, props: ActiveMqBrokerInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ActiveMqBrokerInstanceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ActiveMqBrokerInstanceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAmqpMaximumConnections | *No description.* | | metricBurstBalance | *No description.* | | metricConsumerCount | *No description.* | | metricCpuCreditBalance | *No description.* | | metricCpuUtilization | *No description.* | | metricCurrentConnectionsCount | *No description.* | | metricDequeueCount | *No description.* | | metricDispatchCount | *No description.* | | metricEnqueueCount | *No description.* | | metricEnqueueTime | *No description.* | | metricEstablishedConnectionsCount | *No description.* | | metricExpiredCount | *No description.* | | metricHeapUsage | *No description.* | | metricInactiveDurableTopicSubscribersCount | *No description.* | | metricInFlightCount | *No description.* | | metricJobSchedulerStorePercentUsage | *No description.* | | metricJournalFilesForFastRecovery | *No description.* | | metricJournalFilesForFullRecovery | *No description.* | | metricMemoryUsage | *No description.* | | metricMqttMaximumConnections | *No description.* | | metricNetworkConnectorConnectionCount | *No description.* | | metricNetworkIn | *No description.* | | metricNetworkOut | *No description.* | | metricOpenTransactionCount | *No description.* | | metricOpenwireMaximumConnections | *No description.* | | metricProducerCount | *No description.* | | metricQueueSize | *No description.* | | metricReceiveCount | *No description.* | | metricStompMaximumConnections | *No description.* | | metricStorePercentUsage | *No description.* | | metricTempPercentUsage | *No description.* | | metricTotalConsumerCount | *No description.* | | metricTotalDequeueCount | *No description.* | | metricTotalEnqueueCount | *No description.* | | metricTotalMessageCount | *No description.* | | metricTotalProducerCount | *No description.* | | metricVolumeReadOps | *No description.* | | metricVolumeWriteOps | *No description.* | | metricWsMaximumConnections | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAmqpMaximumConnections` ```typescript public metricAmqpMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBurstBalance` ```typescript public metricBurstBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuCreditBalance` ```typescript public metricCpuCreditBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuUtilization` ```typescript public metricCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCurrentConnectionsCount` ```typescript public metricCurrentConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDequeueCount` ```typescript public metricDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDispatchCount` ```typescript public metricDispatchCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueCount` ```typescript public metricEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueTime` ```typescript public metricEnqueueTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEstablishedConnectionsCount` ```typescript public metricEstablishedConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExpiredCount` ```typescript public metricExpiredCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricHeapUsage` ```typescript public metricHeapUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInactiveDurableTopicSubscribersCount` ```typescript public metricInactiveDurableTopicSubscribersCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInFlightCount` ```typescript public metricInFlightCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJobSchedulerStorePercentUsage` ```typescript public metricJobSchedulerStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFastRecovery` ```typescript public metricJournalFilesForFastRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFullRecovery` ```typescript public metricJournalFilesForFullRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMemoryUsage` ```typescript public metricMemoryUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMqttMaximumConnections` ```typescript public metricMqttMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkConnectorConnectionCount` ```typescript public metricNetworkConnectorConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkIn` ```typescript public metricNetworkIn(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkOut` ```typescript public metricNetworkOut(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenTransactionCount` ```typescript public metricOpenTransactionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenwireMaximumConnections` ```typescript public metricOpenwireMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricProducerCount` ```typescript public metricProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueSize` ```typescript public metricQueueSize(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricReceiveCount` ```typescript public metricReceiveCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStompMaximumConnections` ```typescript public metricStompMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStorePercentUsage` ```typescript public metricStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTempPercentUsage` ```typescript public metricTempPercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalConsumerCount` ```typescript public metricTotalConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalDequeueCount` ```typescript public metricTotalDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalEnqueueCount` ```typescript public metricTotalEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalMessageCount` ```typescript public metricTotalMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalProducerCount` ```typescript public metricTotalProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeReadOps` ```typescript public metricVolumeReadOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeWriteOps` ```typescript public metricVolumeWriteOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricWsMaximumConnections` ```typescript public metricWsMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromActiveMqBrokerInstanceArn | Reference an existing ActiveMQ Broker Instance, defined outside of the CDK code, by ARN. | | fromActiveMqBrokerInstanceNameAndId | Reference an existing ActiveMQ Broker Instance, defined outside of the CDK code, by its name and id. | --- ##### ~~`isConstruct`~~ ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerInstance.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerInstance.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerInstance.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromActiveMqBrokerInstanceArn` ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerInstance.fromActiveMqBrokerInstanceArn(scope: Construct, logicalId: string, arn: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing ActiveMQ Broker Instance, defined outside of the CDK code, by ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string the construct's logical ID. --- ###### `arn`^Required - *Type:* string the ARN of the existing ActiveMQ Broker Instance that is imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] optionally pass security groups for working with network connections. --- ##### `fromActiveMqBrokerInstanceNameAndId` ```typescript import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerInstance.fromActiveMqBrokerInstanceNameAndId(scope: Construct, logicalId: string, name: string, id: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing ActiveMQ Broker Instance, defined outside of the CDK code, by its name and id. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string --- ###### `name`^Required - *Type:* string the name of the existing ActiveMQ Broker Instance to be imported. --- ###### `id`^Required - *Type:* string the ID of the existing ActiveMQ Broker Instance to be imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] (optional) pass security groups for working with network connections. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | configuration | IActiveMqBrokerConfiguration | *No description.* | | endpoints | ActiveMqBrokerEndpoints | Gets the available endpoints of the Amazon MQ for ActiveMQ broker. | | ipAddress | string | Gets the IP address of the ENI of the Amazon MQ for ActiveMQ broker. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `configuration`^Required ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration --- ##### `endpoints`^Required ```typescript public readonly endpoints: ActiveMqBrokerEndpoints; ``` - *Type:* ActiveMqBrokerEndpoints Gets the available endpoints of the Amazon MQ for ActiveMQ broker. --- ##### `ipAddress`^Required ```typescript public readonly ipAddress: string; ``` - *Type:* string Gets the IP address of the ENI of the Amazon MQ for ActiveMQ broker. --- ### ActiveMqBrokerRedundantPair - *Implements:* IActiveMqBrokerRedundantPair A representation of an active/standby broker that is comprised of two brokers in two different Availability Zones. Additional optimizations: - When subnet selection returns more then 2 subnets. Construct picks first two that do belong to different AZ. Warning is annotated. If subnet selection does not meet AZ criteria an error is thrown. see: https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/active-standby-broker-deployment.html #### Initializers ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerRedundantPair(scope: Construct, id: string, props: ActiveMqBrokerRedundantPairProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ActiveMqBrokerRedundantPairProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ActiveMqBrokerRedundantPairProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAmqpMaximumConnections | *No description.* | | metricBurstBalance | *No description.* | | metricConsumerCount | *No description.* | | metricCpuCreditBalance | *No description.* | | metricCpuUtilization | *No description.* | | metricCurrentConnectionsCount | *No description.* | | metricDequeueCount | *No description.* | | metricDispatchCount | *No description.* | | metricEnqueueCount | *No description.* | | metricEnqueueTime | *No description.* | | metricEstablishedConnectionsCount | *No description.* | | metricExpiredCount | *No description.* | | metricHeapUsage | *No description.* | | metricInactiveDurableTopicSubscribersCount | *No description.* | | metricInFlightCount | *No description.* | | metricJobSchedulerStorePercentUsage | *No description.* | | metricJournalFilesForFastRecovery | *No description.* | | metricJournalFilesForFullRecovery | *No description.* | | metricMemoryUsage | *No description.* | | metricMqttMaximumConnections | *No description.* | | metricNetworkConnectorConnectionCount | *No description.* | | metricNetworkIn | *No description.* | | metricNetworkOut | *No description.* | | metricOpenTransactionCount | *No description.* | | metricOpenwireMaximumConnections | *No description.* | | metricProducerCount | *No description.* | | metricQueueSize | *No description.* | | metricReceiveCount | *No description.* | | metricStompMaximumConnections | *No description.* | | metricStorePercentUsage | *No description.* | | metricTempPercentUsage | *No description.* | | metricTotalConsumerCount | *No description.* | | metricTotalDequeueCount | *No description.* | | metricTotalEnqueueCount | *No description.* | | metricTotalMessageCount | *No description.* | | metricTotalProducerCount | *No description.* | | metricVolumeReadOps | *No description.* | | metricVolumeWriteOps | *No description.* | | metricWsMaximumConnections | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAmqpMaximumConnections` ```typescript public metricAmqpMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBurstBalance` ```typescript public metricBurstBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuCreditBalance` ```typescript public metricCpuCreditBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuUtilization` ```typescript public metricCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCurrentConnectionsCount` ```typescript public metricCurrentConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDequeueCount` ```typescript public metricDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDispatchCount` ```typescript public metricDispatchCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueCount` ```typescript public metricEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueTime` ```typescript public metricEnqueueTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEstablishedConnectionsCount` ```typescript public metricEstablishedConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExpiredCount` ```typescript public metricExpiredCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricHeapUsage` ```typescript public metricHeapUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInactiveDurableTopicSubscribersCount` ```typescript public metricInactiveDurableTopicSubscribersCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInFlightCount` ```typescript public metricInFlightCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJobSchedulerStorePercentUsage` ```typescript public metricJobSchedulerStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFastRecovery` ```typescript public metricJournalFilesForFastRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFullRecovery` ```typescript public metricJournalFilesForFullRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMemoryUsage` ```typescript public metricMemoryUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMqttMaximumConnections` ```typescript public metricMqttMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkConnectorConnectionCount` ```typescript public metricNetworkConnectorConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkIn` ```typescript public metricNetworkIn(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkOut` ```typescript public metricNetworkOut(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenTransactionCount` ```typescript public metricOpenTransactionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenwireMaximumConnections` ```typescript public metricOpenwireMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricProducerCount` ```typescript public metricProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueSize` ```typescript public metricQueueSize(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricReceiveCount` ```typescript public metricReceiveCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStompMaximumConnections` ```typescript public metricStompMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStorePercentUsage` ```typescript public metricStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTempPercentUsage` ```typescript public metricTempPercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalConsumerCount` ```typescript public metricTotalConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalDequeueCount` ```typescript public metricTotalDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalEnqueueCount` ```typescript public metricTotalEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalMessageCount` ```typescript public metricTotalMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalProducerCount` ```typescript public metricTotalProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeReadOps` ```typescript public metricVolumeReadOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeWriteOps` ```typescript public metricVolumeWriteOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricWsMaximumConnections` ```typescript public metricWsMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromActiveMqBrokerRedundantPairArn | Reference an existing ActiveMQ Broker Redundant Pair, defined outside of the CDK code, by ARN. | | fromActiveMqBrokerRedundantPairNameAndId | Reference an existing ActiveMQ Broker Redundant Pair, defined outside of the CDK code, by its name and id. | --- ##### ~~`isConstruct`~~ ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerRedundantPair.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerRedundantPair.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerRedundantPair.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromActiveMqBrokerRedundantPairArn` ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerRedundantPair.fromActiveMqBrokerRedundantPairArn(scope: Construct, logicalId: string, arn: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing ActiveMQ Broker Redundant Pair, defined outside of the CDK code, by ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string the construct's logical ID. --- ###### `arn`^Required - *Type:* string the ARN of the existing ActiveMQ Broker Redundant Pair that is imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] optionally pass security groups for working with network connections. --- ##### `fromActiveMqBrokerRedundantPairNameAndId` ```typescript import { ActiveMqBrokerRedundantPair } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerRedundantPair.fromActiveMqBrokerRedundantPairNameAndId(scope: Construct, logicalId: string, name: string, id: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing ActiveMQ Broker Redundant Pair, defined outside of the CDK code, by its name and id. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string --- ###### `name`^Required - *Type:* string the name of the existing ActiveMQ Broker Redundant Pair to be imported. --- ###### `id`^Required - *Type:* string the ID of the existing ActiveMQ Broker Redundant Pair to be imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] (optional) pass security groups for working with network connections. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | configuration | IActiveMqBrokerConfiguration | *No description.* | | first | IActiveMqBroker | The first broker of the redundant pair for the deployment. | | second | IActiveMqBroker | The second broker of the redundant pair for the deployment. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `configuration`^Required ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration --- ##### `first`^Required ```typescript public readonly first: IActiveMqBroker; ``` - *Type:* IActiveMqBroker The first broker of the redundant pair for the deployment. --- ##### `second`^Required ```typescript public readonly second: IActiveMqBroker; ``` - *Type:* IActiveMqBroker The second broker of the redundant pair for the deployment. --- ### BrokerConfiguration - *Implements:* IBrokerConfiguration #### Initializers ```typescript import { BrokerConfiguration } from '@cdklabs/cdk-amazonmq' new BrokerConfiguration(scope: Construct, id: string, props: ConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ConfigurationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ConfigurationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { BrokerConfiguration } from '@cdklabs/cdk-amazonmq' BrokerConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { BrokerConfiguration } from '@cdklabs/cdk-amazonmq' BrokerConfiguration.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { BrokerConfiguration } from '@cdklabs/cdk-amazonmq' BrokerConfiguration.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### BrokerDeploymentBase - *Implements:* IBrokerDeployment #### Initializers ```typescript import { BrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' new BrokerDeploymentBase(scope: Construct, id: string, props: BrokerDeploymentBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | BrokerDeploymentBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* BrokerDeploymentBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { BrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' BrokerDeploymentBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { BrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' BrokerDeploymentBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { BrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' BrokerDeploymentBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ### ConfigurationAssociation #### Initializers ```typescript import { ConfigurationAssociation } from '@cdklabs/cdk-amazonmq' new ConfigurationAssociation(scope: Construct, id: string, props: ConfigurationAssociationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ConfigurationAssociationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ConfigurationAssociationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { ConfigurationAssociation } from '@cdklabs/cdk-amazonmq' ConfigurationAssociation.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ConfigurationAssociation } from '@cdklabs/cdk-amazonmq' ConfigurationAssociation.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ConfigurationAssociation } from '@cdklabs/cdk-amazonmq' ConfigurationAssociation.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ### RabbitMqBrokerCluster - *Implements:* IRabbitMqBrokerCluster A representation of a RabbitMQ cluster deployment is a logical grouping of three RabbitMQ broker nodes behind a Network Load Balancer, each sharing users, queues, and a distributed state across multiple Availability Zones (AZ). #### Initializers ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerCluster(scope: Construct, id: string, props: RabbitMqBrokerClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RabbitMqBrokerClusterProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RabbitMqBrokerClusterProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAckRate | *No description.* | | metricChannelCount | *No description.* | | metricConfirmRate | *No description.* | | metricConnectionCount | *No description.* | | metricConsumerCount | *No description.* | | metricExchangeCount | *No description.* | | metricMessageCount | *No description.* | | metricMessageReadyCount | *No description.* | | metricMessageUnacknowledgedCount | *No description.* | | metricPublishRate | *No description.* | | metricQueueCount | *No description.* | | metricRabbitMQDiskFree | *No description.* | | metricRabbitMQDiskFreeLimit | *No description.* | | metricRabbitMQFdUsed | *No description.* | | metricRabbitMQIOReadAverageTime | *No description.* | | metricRabbitMQIOWriteAverageTime | *No description.* | | metricRabbitMQMemLimit | *No description.* | | metricRabbitMQMemUsed | *No description.* | | metricSystemCpuUtilization | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAckRate` ```typescript public metricAckRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricChannelCount` ```typescript public metricChannelCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConfirmRate` ```typescript public metricConfirmRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConnectionCount` ```typescript public metricConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExchangeCount` ```typescript public metricExchangeCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageCount` ```typescript public metricMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageReadyCount` ```typescript public metricMessageReadyCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageUnacknowledgedCount` ```typescript public metricMessageUnacknowledgedCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricPublishRate` ```typescript public metricPublishRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueCount` ```typescript public metricQueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFree` ```typescript public metricRabbitMQDiskFree(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFreeLimit` ```typescript public metricRabbitMQDiskFreeLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQFdUsed` ```typescript public metricRabbitMQFdUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOReadAverageTime` ```typescript public metricRabbitMQIOReadAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOWriteAverageTime` ```typescript public metricRabbitMQIOWriteAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemLimit` ```typescript public metricRabbitMQMemLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemUsed` ```typescript public metricRabbitMQMemUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSystemCpuUtilization` ```typescript public metricSystemCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromRabbitMqBrokerClusterArn | Reference an existing RabbitMQ Broker Cluster, defined outside of the CDK code, by ARN. | | fromRabbitMqBrokerClusterNameAndId | Reference an existing RabbitMQ Broker Cluster, defined outside of the CDK code, by name and id. | --- ##### ~~`isConstruct`~~ ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerCluster.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerCluster.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerCluster.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromRabbitMqBrokerClusterArn` ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerCluster.fromRabbitMqBrokerClusterArn(scope: Construct, logicalId: string, arn: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing RabbitMQ Broker Cluster, defined outside of the CDK code, by ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string the construct's logical ID. --- ###### `arn`^Required - *Type:* string the ARN of the existing AcitveMQ Broker Cluster that is imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] optionally pass security groups for working with network connections. --- ##### `fromRabbitMqBrokerClusterNameAndId` ```typescript import { RabbitMqBrokerCluster } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerCluster.fromRabbitMqBrokerClusterNameAndId(scope: Construct, logicalId: string, name: string, id: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing RabbitMQ Broker Cluster, defined outside of the CDK code, by name and id. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string the construct's logical ID. --- ###### `name`^Required - *Type:* string the name of the existing RabbitMQ Broker Cluster to be imported. --- ###### `id`^Required - *Type:* string the ID of the existing RabbitMQ Broker Cluster to be imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] optionally pass security groups for working with network connections. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | endpoints | RabbitMqBrokerEndpoints | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ### RabbitMqBrokerConfiguration #### Initializers ```typescript import { RabbitMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerConfiguration(scope: Construct, id: string, props: RabbitMqBrokerConfigurationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RabbitMqBrokerConfigurationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RabbitMqBrokerConfigurationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | associateWith | *No description.* | | createRevision | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `associateWith` ```typescript public associateWith(broker: IRabbitMqBrokerDeployment): ConfigurationAssociation ``` ###### `broker`^Required - *Type:* IRabbitMqBrokerDeployment --- ##### `createRevision` ```typescript public createRevision(options: RabbitMqBrokerConfigurationOptions): IRabbitMqBrokerConfiguration ``` ###### `options`^Required - *Type:* RabbitMqBrokerConfigurationOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromAttributes | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { RabbitMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfiguration.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { RabbitMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfiguration.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RabbitMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfiguration.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAttributes` ```typescript import { RabbitMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfiguration.fromAttributes(scope: Construct, logicalId: string, attrs: BrokerConfigurationAttributes) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* BrokerConfigurationAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### RabbitMqBrokerDeploymentBase - *Implements:* IRabbitMqBrokerDeployment, IRabbitMqBroker #### Initializers ```typescript import { RabbitMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerDeploymentBase(scope: Construct, id: string, props: RabbitMqBrokerDeploymentBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RabbitMqBrokerDeploymentBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RabbitMqBrokerDeploymentBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAckRate | *No description.* | | metricChannelCount | *No description.* | | metricConfirmRate | *No description.* | | metricConnectionCount | *No description.* | | metricConsumerCount | *No description.* | | metricExchangeCount | *No description.* | | metricMessageCount | *No description.* | | metricMessageReadyCount | *No description.* | | metricMessageUnacknowledgedCount | *No description.* | | metricPublishRate | *No description.* | | metricQueueCount | *No description.* | | metricRabbitMQDiskFree | *No description.* | | metricRabbitMQDiskFreeLimit | *No description.* | | metricRabbitMQFdUsed | *No description.* | | metricRabbitMQIOReadAverageTime | *No description.* | | metricRabbitMQIOWriteAverageTime | *No description.* | | metricRabbitMQMemLimit | *No description.* | | metricRabbitMQMemUsed | *No description.* | | metricSystemCpuUtilization | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAckRate` ```typescript public metricAckRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricChannelCount` ```typescript public metricChannelCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConfirmRate` ```typescript public metricConfirmRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConnectionCount` ```typescript public metricConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExchangeCount` ```typescript public metricExchangeCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageCount` ```typescript public metricMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageReadyCount` ```typescript public metricMessageReadyCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageUnacknowledgedCount` ```typescript public metricMessageUnacknowledgedCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricPublishRate` ```typescript public metricPublishRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueCount` ```typescript public metricQueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFree` ```typescript public metricRabbitMQDiskFree(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFreeLimit` ```typescript public metricRabbitMQDiskFreeLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQFdUsed` ```typescript public metricRabbitMQFdUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOReadAverageTime` ```typescript public metricRabbitMQIOReadAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOWriteAverageTime` ```typescript public metricRabbitMQIOWriteAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemLimit` ```typescript public metricRabbitMQMemLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemUsed` ```typescript public metricRabbitMQMemUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSystemCpuUtilization` ```typescript public metricSystemCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### ~~`isConstruct`~~ ```typescript import { RabbitMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerDeploymentBase.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { RabbitMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerDeploymentBase.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RabbitMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerDeploymentBase.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | endpoints | RabbitMqBrokerEndpoints | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ### RabbitMqBrokerInstance - *Implements:* IRabbitMqBrokerInstance A representation of a single-instance broker comprised of one broker in one Availability Zone behind a Network Load Balancer (NLB) Additional optimizations: - When subnet selection returns more then 1 subnets. A first one is picked. Warning is annotated #### Initializers ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerInstance(scope: Construct, id: string, props: RabbitMqBrokerInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RabbitMqBrokerInstanceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RabbitMqBrokerInstanceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | metric | *No description.* | | metricAckRate | *No description.* | | metricChannelCount | *No description.* | | metricConfirmRate | *No description.* | | metricConnectionCount | *No description.* | | metricConsumerCount | *No description.* | | metricExchangeCount | *No description.* | | metricMessageCount | *No description.* | | metricMessageReadyCount | *No description.* | | metricMessageUnacknowledgedCount | *No description.* | | metricPublishRate | *No description.* | | metricQueueCount | *No description.* | | metricRabbitMQDiskFree | *No description.* | | metricRabbitMQDiskFreeLimit | *No description.* | | metricRabbitMQFdUsed | *No description.* | | metricRabbitMQIOReadAverageTime | *No description.* | | metricRabbitMQIOWriteAverageTime | *No description.* | | metricRabbitMQMemLimit | *No description.* | | metricRabbitMQMemUsed | *No description.* | | metricSystemCpuUtilization | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAckRate` ```typescript public metricAckRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricChannelCount` ```typescript public metricChannelCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConfirmRate` ```typescript public metricConfirmRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConnectionCount` ```typescript public metricConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExchangeCount` ```typescript public metricExchangeCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageCount` ```typescript public metricMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageReadyCount` ```typescript public metricMessageReadyCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageUnacknowledgedCount` ```typescript public metricMessageUnacknowledgedCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricPublishRate` ```typescript public metricPublishRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueCount` ```typescript public metricQueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFree` ```typescript public metricRabbitMQDiskFree(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFreeLimit` ```typescript public metricRabbitMQDiskFreeLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQFdUsed` ```typescript public metricRabbitMQFdUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOReadAverageTime` ```typescript public metricRabbitMQIOReadAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOWriteAverageTime` ```typescript public metricRabbitMQIOWriteAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemLimit` ```typescript public metricRabbitMQMemLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemUsed` ```typescript public metricRabbitMQMemUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSystemCpuUtilization` ```typescript public metricSystemCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromRabbitMqBrokerInstanceArn | Reference an existing RabbitMQ Broker Instance, defined outside of the CDK code, by ARN. | | fromRabbitMqBrokerInstanceNameAndId | Reference an existing RabbitMQ Broker Instance, defined outside of the CDK code, by its name and id. | --- ##### ~~`isConstruct`~~ ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerInstance.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerInstance.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerInstance.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromRabbitMqBrokerInstanceArn` ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerInstance.fromRabbitMqBrokerInstanceArn(scope: Construct, logicalId: string, arn: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing RabbitMQ Broker Instance, defined outside of the CDK code, by ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string the construct's logical ID. --- ###### `arn`^Required - *Type:* string the ARN of the existing RabbitMQ Broker Instance that is imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] optionally pass security groups for working with network connections. --- ##### `fromRabbitMqBrokerInstanceNameAndId` ```typescript import { RabbitMqBrokerInstance } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerInstance.fromRabbitMqBrokerInstanceNameAndId(scope: Construct, logicalId: string, name: string, id: string, securityGroups?: ISecurityGroup[]) ``` Reference an existing RabbitMQ Broker Instance, defined outside of the CDK code, by its name and id. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `logicalId`^Required - *Type:* string --- ###### `name`^Required - *Type:* string the name of the existing RabbitMQ Broker Instance to be imported. --- ###### `id`^Required - *Type:* string the ID of the existing RabbitMQ Broker Instance to be imported. --- ###### `securityGroups`^Optional - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] (optional) pass security groups for working with network connections. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | Manages connections for the cluster. | | endpoints | RabbitMqBrokerEndpoints | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Manages connections for the cluster. --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ### RabbitMqCustomResource - *Implements:* aws-cdk-lib.aws_ec2.IConnectable, aws-cdk-lib.aws_iam.IGrantable #### Initializers ```typescript import { RabbitMqCustomResource } from '@cdklabs/cdk-amazonmq' new RabbitMqCustomResource(scope: Construct, id: string, props: RabbitMqCustomResourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RabbitMqCustomResourceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RabbitMqCustomResourceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | getResponseField | *No description.* | | getResponseFieldReference | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `getResponseField` ```typescript public getResponseField(key: string): string ``` ###### `key`^Required - *Type:* string --- ##### `getResponseFieldReference` ```typescript public getResponseFieldReference(key: string): Reference ``` ###### `key`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { RabbitMqCustomResource } from '@cdklabs/cdk-amazonmq' RabbitMqCustomResource.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal to grant permissions to. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to. --- ## Structs ### ActiveMqBrokerConfigurationOptions #### Initializer ```typescript import { ActiveMqBrokerConfigurationOptions } from '@cdklabs/cdk-amazonmq' const activeMqBrokerConfigurationOptions: ActiveMqBrokerConfigurationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | definition | ActiveMqBrokerConfigurationDefinition | *No description.* | | description | string | *No description.* | --- ##### `definition`^Required ```typescript public readonly definition: ActiveMqBrokerConfigurationDefinition; ``` - *Type:* ActiveMqBrokerConfigurationDefinition --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ### ActiveMqBrokerConfigurationProps #### Initializer ```typescript import { ActiveMqBrokerConfigurationProps } from '@cdklabs/cdk-amazonmq' const activeMqBrokerConfigurationProps: ActiveMqBrokerConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | definition | ActiveMqBrokerConfigurationDefinition | *No description.* | | description | string | *No description.* | | engineVersion | ActiveMqBrokerEngineVersion | *No description.* | | authenticationStrategy | ActiveMqAuthenticationStrategy | Sets authentication strategy for the broker. | | configurationName | string | *No description.* | --- ##### `definition`^Required ```typescript public readonly definition: ActiveMqBrokerConfigurationDefinition; ``` - *Type:* ActiveMqBrokerConfigurationDefinition --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `engineVersion`^Required ```typescript public readonly engineVersion: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion --- ##### `authenticationStrategy`^Optional ```typescript public readonly authenticationStrategy: ActiveMqAuthenticationStrategy; ``` - *Type:* ActiveMqAuthenticationStrategy - *Default:* undefined; a SIMPLE authentication strategy will be applied Sets authentication strategy for the broker. --- ##### `configurationName`^Optional ```typescript public readonly configurationName: string; ``` - *Type:* string --- ### ActiveMqBrokerDeploymentBaseProps #### Initializer ```typescript import { ActiveMqBrokerDeploymentBaseProps } from '@cdklabs/cdk-amazonmq' const activeMqBrokerDeploymentBaseProps: ActiveMqBrokerDeploymentBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | userManagement | IActiveMqBrokerUserManagement | Sets the User Management option for the Amazon MQ for ActiveMQ broker. | | version | ActiveMqBrokerEngineVersion | Sets the version of the Amazon MQ for ActiveMQ broker engine. | | cloudwatchLogsExports | ActiveMqCloudwatchLogsExports | Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. | | configuration | IActiveMqBrokerConfiguration | Sets the configuration of the Amazon MQ for ActiveMQ broker. | | logsRetentionDays | number | Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. | | deploymentMode | BrokerDeploymentMode | *No description.* | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `userManagement`^Required ```typescript public readonly userManagement: IActiveMqBrokerUserManagement; ``` - *Type:* IActiveMqBrokerUserManagement Sets the User Management option for the Amazon MQ for ActiveMQ broker. --- ##### `version`^Required ```typescript public readonly version: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion Sets the version of the Amazon MQ for ActiveMQ broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: ActiveMqCloudwatchLogsExports; ``` - *Type:* ActiveMqCloudwatchLogsExports - *Default:* undefined; No logs are exported to CloudWatch. Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration Sets the configuration of the Amazon MQ for ActiveMQ broker. --- ##### `logsRetentionDays`^Optional ```typescript public readonly logsRetentionDays: number; ``` - *Type:* number Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. --- ##### `deploymentMode`^Required ```typescript public readonly deploymentMode: BrokerDeploymentMode; ``` - *Type:* BrokerDeploymentMode --- ### ActiveMqBrokerDeploymentProps #### Initializer ```typescript import { ActiveMqBrokerDeploymentProps } from '@cdklabs/cdk-amazonmq' const activeMqBrokerDeploymentProps: ActiveMqBrokerDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | userManagement | IActiveMqBrokerUserManagement | Sets the User Management option for the Amazon MQ for ActiveMQ broker. | | version | ActiveMqBrokerEngineVersion | Sets the version of the Amazon MQ for ActiveMQ broker engine. | | cloudwatchLogsExports | ActiveMqCloudwatchLogsExports | Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. | | configuration | IActiveMqBrokerConfiguration | Sets the configuration of the Amazon MQ for ActiveMQ broker. | | logsRetentionDays | number | Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `userManagement`^Required ```typescript public readonly userManagement: IActiveMqBrokerUserManagement; ``` - *Type:* IActiveMqBrokerUserManagement Sets the User Management option for the Amazon MQ for ActiveMQ broker. --- ##### `version`^Required ```typescript public readonly version: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion Sets the version of the Amazon MQ for ActiveMQ broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: ActiveMqCloudwatchLogsExports; ``` - *Type:* ActiveMqCloudwatchLogsExports - *Default:* undefined; No logs are exported to CloudWatch. Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration Sets the configuration of the Amazon MQ for ActiveMQ broker. --- ##### `logsRetentionDays`^Optional ```typescript public readonly logsRetentionDays: number; ``` - *Type:* number Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. --- ### ActiveMqBrokerDeploymentUserManagementDefinition #### Initializer ```typescript import { ActiveMqBrokerDeploymentUserManagementDefinition } from '@cdklabs/cdk-amazonmq' const activeMqBrokerDeploymentUserManagementDefinition: ActiveMqBrokerDeploymentUserManagementDefinition = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | users | aws-cdk-lib.aws_amazonmq.CfnBroker.UserProperty[] | *No description.* | | authenticationStrategy | ActiveMqAuthenticationStrategy | *No description.* | | ldapServerMetadata | aws-cdk-lib.aws_amazonmq.CfnBroker.LdapServerMetadataProperty | *No description.* | --- ##### `users`^Required ```typescript public readonly users: UserProperty[]; ``` - *Type:* aws-cdk-lib.aws_amazonmq.CfnBroker.UserProperty[] --- ##### `authenticationStrategy`^Optional ```typescript public readonly authenticationStrategy: ActiveMqAuthenticationStrategy; ``` - *Type:* ActiveMqAuthenticationStrategy --- ##### `ldapServerMetadata`^Optional ```typescript public readonly ldapServerMetadata: LdapServerMetadataProperty; ``` - *Type:* aws-cdk-lib.aws_amazonmq.CfnBroker.LdapServerMetadataProperty --- ### ActiveMqBrokerEndpoints #### Initializer ```typescript import { ActiveMqBrokerEndpoints } from '@cdklabs/cdk-amazonmq' const activeMqBrokerEndpoints: ActiveMqBrokerEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | amqp | BrokerEndpoint | The AMQP endpoint of the broker. | | console | BrokerEndpoint | *No description.* | | mqtt | BrokerEndpoint | The MQTT endpoint of the broker. | | openWire | BrokerEndpoint | The OpenWire endpoint of the broker. | | stomp | BrokerEndpoint | The STOMP endpoint of the broker. | | wss | BrokerEndpoint | The WSS endpoint of the broker. | --- ##### `amqp`^Required ```typescript public readonly amqp: BrokerEndpoint; ``` - *Type:* BrokerEndpoint The AMQP endpoint of the broker. --- ##### `console`^Required ```typescript public readonly console: BrokerEndpoint; ``` - *Type:* BrokerEndpoint --- ##### `mqtt`^Required ```typescript public readonly mqtt: BrokerEndpoint; ``` - *Type:* BrokerEndpoint The MQTT endpoint of the broker. --- ##### `openWire`^Required ```typescript public readonly openWire: BrokerEndpoint; ``` - *Type:* BrokerEndpoint The OpenWire endpoint of the broker. --- ##### `stomp`^Required ```typescript public readonly stomp: BrokerEndpoint; ``` - *Type:* BrokerEndpoint The STOMP endpoint of the broker. --- ##### `wss`^Required ```typescript public readonly wss: BrokerEndpoint; ``` - *Type:* BrokerEndpoint The WSS endpoint of the broker. --- ### ActiveMqBrokerInstanceProps #### Initializer ```typescript import { ActiveMqBrokerInstanceProps } from '@cdklabs/cdk-amazonmq' const activeMqBrokerInstanceProps: ActiveMqBrokerInstanceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | userManagement | IActiveMqBrokerUserManagement | Sets the User Management option for the Amazon MQ for ActiveMQ broker. | | version | ActiveMqBrokerEngineVersion | Sets the version of the Amazon MQ for ActiveMQ broker engine. | | cloudwatchLogsExports | ActiveMqCloudwatchLogsExports | Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. | | configuration | IActiveMqBrokerConfiguration | Sets the configuration of the Amazon MQ for ActiveMQ broker. | | logsRetentionDays | number | Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. | | storageType | StorageType | Sets the storage type of the Amazon MQ for ActiveMQ broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `userManagement`^Required ```typescript public readonly userManagement: IActiveMqBrokerUserManagement; ``` - *Type:* IActiveMqBrokerUserManagement Sets the User Management option for the Amazon MQ for ActiveMQ broker. --- ##### `version`^Required ```typescript public readonly version: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion Sets the version of the Amazon MQ for ActiveMQ broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: ActiveMqCloudwatchLogsExports; ``` - *Type:* ActiveMqCloudwatchLogsExports - *Default:* undefined; No logs are exported to CloudWatch. Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration Sets the configuration of the Amazon MQ for ActiveMQ broker. --- ##### `logsRetentionDays`^Optional ```typescript public readonly logsRetentionDays: number; ``` - *Type:* number Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. --- ##### `storageType`^Optional ```typescript public readonly storageType: StorageType; ``` - *Type:* StorageType - *Default:* undefined; EFS will be used. Sets the storage type of the Amazon MQ for ActiveMQ broker. --- ### ActiveMqBrokerRedundantPairProps #### Initializer ```typescript import { ActiveMqBrokerRedundantPairProps } from '@cdklabs/cdk-amazonmq' const activeMqBrokerRedundantPairProps: ActiveMqBrokerRedundantPairProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | userManagement | IActiveMqBrokerUserManagement | Sets the User Management option for the Amazon MQ for ActiveMQ broker. | | version | ActiveMqBrokerEngineVersion | Sets the version of the Amazon MQ for ActiveMQ broker engine. | | cloudwatchLogsExports | ActiveMqCloudwatchLogsExports | Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. | | configuration | IActiveMqBrokerConfiguration | Sets the configuration of the Amazon MQ for ActiveMQ broker. | | logsRetentionDays | number | Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `userManagement`^Required ```typescript public readonly userManagement: IActiveMqBrokerUserManagement; ``` - *Type:* IActiveMqBrokerUserManagement Sets the User Management option for the Amazon MQ for ActiveMQ broker. --- ##### `version`^Required ```typescript public readonly version: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion Sets the version of the Amazon MQ for ActiveMQ broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: ActiveMqCloudwatchLogsExports; ``` - *Type:* ActiveMqCloudwatchLogsExports - *Default:* undefined; No logs are exported to CloudWatch. Sets the CloudWatch Logs exports for the Amazon MQ for ActiveMQ broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IActiveMqBrokerConfiguration; ``` - *Type:* IActiveMqBrokerConfiguration Sets the configuration of the Amazon MQ for ActiveMQ broker. --- ##### `logsRetentionDays`^Optional ```typescript public readonly logsRetentionDays: number; ``` - *Type:* number Sets the number of days to retain logs for the Amazon MQ for ActiveMQ broker. --- ### ActiveMqCloudwatchLogsExports #### Initializer ```typescript import { ActiveMqCloudwatchLogsExports } from '@cdklabs/cdk-amazonmq' const activeMqCloudwatchLogsExports: ActiveMqCloudwatchLogsExports = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | audit | boolean | Export audit logs to CloudWatch. | | general | boolean | Export general logs to CloudWatch. | --- ##### `audit`^Optional ```typescript public readonly audit: boolean; ``` - *Type:* boolean - *Default:* undefined; do not export audit logs. Export audit logs to CloudWatch. --- ##### `general`^Optional ```typescript public readonly general: boolean; ``` - *Type:* boolean - *Default:* undefined; do not export general logs. Export general logs to CloudWatch. --- ### ActiveMqEventSourceProps #### Initializer ```typescript import { ActiveMqEventSourceProps } from '@cdklabs/cdk-amazonmq' const activeMqEventSourceProps: ActiveMqEventSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | A secret with credentials of the user to use when receiving messages. | | queueName | string | The name of the queue that the function will receive messages from. | | addPermissions | boolean | If the default permissions should be added to the Lambda function's execution role. | | batchSize | number | source at the time of invoking your function. | | enabled | boolean | If the stream event source mapping should be enabled. | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | | broker | IActiveMqBrokerDeployment | The ActiveMQ broker deployment to receive messages from. | --- ##### `credentials`^Required ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret A secret with credentials of the user to use when receiving messages. The credentials in the secret have fields required: * username * password --- ##### `queueName`^Required ```typescript public readonly queueName: string; ``` - *Type:* string The name of the queue that the function will receive messages from. --- ##### `addPermissions`^Optional ```typescript public readonly addPermissions: boolean; ``` - *Type:* boolean - *Default:* true If the default permissions should be added to the Lambda function's execution role. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 100 source at the time of invoking your function. Your function receives an The largest number of records that AWS Lambda will retrieve from your event event with all the retrieved records. Valid Range: * Minimum value of 1 * Maximum value of: 10000 --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the stream event source mapping should be enabled. --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.millis(500) for Amazon MQ. The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5). > [https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching) --- ##### `broker`^Required ```typescript public readonly broker: IActiveMqBrokerDeployment; ``` - *Type:* IActiveMqBrokerDeployment The ActiveMQ broker deployment to receive messages from. --- ### ActiveMqLdapAuthorization #### Initializer ```typescript import { ActiveMqLdapAuthorization } from '@cdklabs/cdk-amazonmq' const activeMqLdapAuthorization: ActiveMqLdapAuthorization = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hosts | string[] | Sets the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. | | roleBase | string | The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. | | roleSearchMatching | string | The LDAP search filter used to find roles within the roleBase. | | serviceAccountPassword | aws-cdk-lib.SecretValue | Service account password. | | serviceAccountUsername | aws-cdk-lib.SecretValue | Service account username. | | userBase | string | Select a particular subtree of the directory information tree (DIT) to search for user entries. | | userRoleName | string | The name of the LDAP attribute in the user's directory entry for the user's group membership. | | userSearchMatching | string | The LDAP search filter used to find users within the userBase. | | roleName | string | The group name attribute in a role entry whose value is the name of that role. | | roleSearchSubtree | boolean | The directory search scope for the role. | | userSearchSubtree | boolean | The directory search scope for the user. | --- ##### `hosts`^Required ```typescript public readonly hosts: string[]; ``` - *Type:* string[] Sets the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. Optional failover server. --- ##### `roleBase`^Required ```typescript public readonly roleBase: string; ``` - *Type:* string The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com. --- ##### `roleSearchMatching`^Required ```typescript public readonly roleSearchMatching: string; ``` - *Type:* string The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases. --- ##### `serviceAccountPassword`^Required ```typescript public readonly serviceAccountPassword: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com. --- ##### `serviceAccountUsername`^Required ```typescript public readonly serviceAccountUsername: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin, ou=corp, dc=corp, dc=example, dc=com. --- ##### `userBase`^Required ```typescript public readonly userBase: string; ``` - *Type:* string Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users,ou=corp, dc=corp, dc=example, dc=com. --- ##### `userRoleName`^Required ```typescript public readonly userRoleName: string; ``` - *Type:* string The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute. --- ##### `userSearchMatching`^Required ```typescript public readonly userSearchMatching: string; ``` - *Type:* string The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users, ou=corp, dc=corp, dc=example, dc=com. --- ##### `roleName`^Optional ```typescript public readonly roleName: string; ``` - *Type:* string The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of. --- ##### `roleSearchSubtree`^Optional ```typescript public readonly roleSearchSubtree: boolean; ``` - *Type:* boolean The directory search scope for the role. If set to true, scope is to search the entire subtree. --- ##### `userSearchSubtree`^Optional ```typescript public readonly userSearchSubtree: boolean; ``` - *Type:* boolean The directory search scope for the user. If set to true, scope is to search the entire subtree. --- ### ActiveMqUser #### Initializer ```typescript import { ActiveMqUser } from '@cdklabs/cdk-amazonmq' const activeMqUser: ActiveMqUser = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | *No description.* | | username | string | *No description.* | | groups | string[] | *No description.* | | hasConsoleAccess | boolean | *No description.* | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string --- ##### `groups`^Optional ```typescript public readonly groups: string[]; ``` - *Type:* string[] --- ##### `hasConsoleAccess`^Optional ```typescript public readonly hasConsoleAccess: boolean; ``` - *Type:* boolean --- ### Admin #### Initializer ```typescript import { Admin } from '@cdklabs/cdk-amazonmq' const admin: Admin = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | password | aws-cdk-lib.SecretValue | Sets the administrative user password. | | username | string | Sets the administrative user name. | --- ##### `password`^Required ```typescript public readonly password: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue Sets the administrative user password. --- ##### `username`^Required ```typescript public readonly username: string; ``` - *Type:* string Sets the administrative user name. --- ### BrokerCloudwatchLogsExports #### Initializer ```typescript import { BrokerCloudwatchLogsExports } from '@cdklabs/cdk-amazonmq' const brokerCloudwatchLogsExports: BrokerCloudwatchLogsExports = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | audit | boolean | *No description.* | | channel | boolean | *No description.* | | connection | boolean | *No description.* | | general | boolean | *No description.* | | mirroring | boolean | *No description.* | --- ##### `audit`^Optional ```typescript public readonly audit: boolean; ``` - *Type:* boolean --- ##### `channel`^Optional ```typescript public readonly channel: boolean; ``` - *Type:* boolean --- ##### `connection`^Optional ```typescript public readonly connection: boolean; ``` - *Type:* boolean --- ##### `general`^Optional ```typescript public readonly general: boolean; ``` - *Type:* boolean --- ##### `mirroring`^Optional ```typescript public readonly mirroring: boolean; ``` - *Type:* boolean --- ### BrokerConfigurationAttributes #### Initializer ```typescript import { BrokerConfigurationAttributes } from '@cdklabs/cdk-amazonmq' const brokerConfigurationAttributes: BrokerConfigurationAttributes = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | revision | number | *No description.* | | arn | string | *No description.* | | id | string | *No description.* | --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ##### `arn`^Optional ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Optional ```typescript public readonly id: string; ``` - *Type:* string --- ### BrokerDeploymentBaseProps #### Initializer ```typescript import { BrokerDeploymentBaseProps } from '@cdklabs/cdk-amazonmq' const brokerDeploymentBaseProps: BrokerDeploymentBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | deploymentMode | BrokerDeploymentMode | *No description.* | | engine | BrokerEngine | *No description.* | | users | aws-cdk-lib.aws_amazonmq.CfnBroker.UserProperty[] | *No description.* | | version | string | *No description.* | | authenticationStrategy | string | *No description.* | | cloudwatchLogsExports | BrokerCloudwatchLogsExports | *No description.* | | configuration | IBrokerConfiguration | *No description.* | | defaultPort | aws-cdk-lib.aws_ec2.Port | *No description.* | | ldapServerMetadata | aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_amazonmq.CfnBroker.LdapServerMetadataProperty | *No description.* | | storageType | StorageType | *No description.* | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `deploymentMode`^Required ```typescript public readonly deploymentMode: BrokerDeploymentMode; ``` - *Type:* BrokerDeploymentMode --- ##### `engine`^Required ```typescript public readonly engine: BrokerEngine; ``` - *Type:* BrokerEngine --- ##### `users`^Required ```typescript public readonly users: UserProperty[]; ``` - *Type:* aws-cdk-lib.aws_amazonmq.CfnBroker.UserProperty[] --- ##### `version`^Required ```typescript public readonly version: string; ``` - *Type:* string --- ##### `authenticationStrategy`^Optional ```typescript public readonly authenticationStrategy: string; ``` - *Type:* string --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: BrokerCloudwatchLogsExports; ``` - *Type:* BrokerCloudwatchLogsExports --- ##### `configuration`^Optional ```typescript public readonly configuration: IBrokerConfiguration; ``` - *Type:* IBrokerConfiguration --- ##### `defaultPort`^Optional ```typescript public readonly defaultPort: Port; ``` - *Type:* aws-cdk-lib.aws_ec2.Port --- ##### `ldapServerMetadata`^Optional ```typescript public readonly ldapServerMetadata: IResolvable | LdapServerMetadataProperty; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.aws_amazonmq.CfnBroker.LdapServerMetadataProperty --- ##### `storageType`^Optional ```typescript public readonly storageType: StorageType; ``` - *Type:* StorageType --- ### BrokerDeploymentProps #### Initializer ```typescript import { BrokerDeploymentProps } from '@cdklabs/cdk-amazonmq' const brokerDeploymentProps: BrokerDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ### BrokerEndpoint #### Initializer ```typescript import { BrokerEndpoint } from '@cdklabs/cdk-amazonmq' const brokerEndpoint: BrokerEndpoint = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | port | number | The port at which the endpoint awaits communication. | | url | string | The full URL of the broker endpoint, including the port. | --- ##### `port`^Required ```typescript public readonly port: number; ``` - *Type:* number The port at which the endpoint awaits communication. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string The full URL of the broker endpoint, including the port. --- ### ConfigurationAssociationProps #### Initializer ```typescript import { ConfigurationAssociationProps } from '@cdklabs/cdk-amazonmq' const configurationAssociationProps: ConfigurationAssociationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | broker | IBrokerDeployment | *No description.* | | configuration | IBrokerConfiguration | *No description.* | --- ##### `broker`^Required ```typescript public readonly broker: IBrokerDeployment; ``` - *Type:* IBrokerDeployment --- ##### `configuration`^Required ```typescript public readonly configuration: IBrokerConfiguration; ``` - *Type:* IBrokerConfiguration --- ### ConfigurationProps #### Initializer ```typescript import { ConfigurationProps } from '@cdklabs/cdk-amazonmq' const configurationProps: ConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | data | string | *No description.* | | engine | BrokerEngine | *No description.* | | authenticationStrategy | ActiveMqAuthenticationStrategy | *No description.* | | configurationName | string | *No description.* | | description | string | *No description.* | | engineVersion | string | *No description.* | --- ##### `data`^Required ```typescript public readonly data: string; ``` - *Type:* string --- ##### `engine`^Required ```typescript public readonly engine: BrokerEngine; ``` - *Type:* BrokerEngine --- ##### `authenticationStrategy`^Optional ```typescript public readonly authenticationStrategy: ActiveMqAuthenticationStrategy; ``` - *Type:* ActiveMqAuthenticationStrategy --- ##### `configurationName`^Optional ```typescript public readonly configurationName: string; ``` - *Type:* string --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `engineVersion`^Optional ```typescript public readonly engineVersion: string; ``` - *Type:* string --- ### EventSourceBaseProps #### Initializer ```typescript import { EventSourceBaseProps } from '@cdklabs/cdk-amazonmq' const eventSourceBaseProps: EventSourceBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | A secret with credentials of the user to use when receiving messages. | | queueName | string | The name of the queue that the function will receive messages from. | | addPermissions | boolean | If the default permissions should be added to the Lambda function's execution role. | | batchSize | number | source at the time of invoking your function. | | enabled | boolean | If the stream event source mapping should be enabled. | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | | broker | IBrokerDeployment | The Amazon MQ broker deployment to receive messages from. | --- ##### `credentials`^Required ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret A secret with credentials of the user to use when receiving messages. The credentials in the secret have fields required: * username * password --- ##### `queueName`^Required ```typescript public readonly queueName: string; ``` - *Type:* string The name of the queue that the function will receive messages from. --- ##### `addPermissions`^Optional ```typescript public readonly addPermissions: boolean; ``` - *Type:* boolean - *Default:* true If the default permissions should be added to the Lambda function's execution role. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 100 source at the time of invoking your function. Your function receives an The largest number of records that AWS Lambda will retrieve from your event event with all the retrieved records. Valid Range: * Minimum value of 1 * Maximum value of: 10000 --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the stream event source mapping should be enabled. --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.millis(500) for Amazon MQ. The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5). > [https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching) --- ##### `broker`^Required ```typescript public readonly broker: IBrokerDeployment; ``` - *Type:* IBrokerDeployment The Amazon MQ broker deployment to receive messages from. --- ### EventSourceProps #### Initializer ```typescript import { EventSourceProps } from '@cdklabs/cdk-amazonmq' const eventSourceProps: EventSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | A secret with credentials of the user to use when receiving messages. | | queueName | string | The name of the queue that the function will receive messages from. | | addPermissions | boolean | If the default permissions should be added to the Lambda function's execution role. | | batchSize | number | source at the time of invoking your function. | | enabled | boolean | If the stream event source mapping should be enabled. | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | --- ##### `credentials`^Required ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret A secret with credentials of the user to use when receiving messages. The credentials in the secret have fields required: * username * password --- ##### `queueName`^Required ```typescript public readonly queueName: string; ``` - *Type:* string The name of the queue that the function will receive messages from. --- ##### `addPermissions`^Optional ```typescript public readonly addPermissions: boolean; ``` - *Type:* boolean - *Default:* true If the default permissions should be added to the Lambda function's execution role. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 100 source at the time of invoking your function. Your function receives an The largest number of records that AWS Lambda will retrieve from your event event with all the retrieved records. Valid Range: * Minimum value of 1 * Maximum value of: 10000 --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the stream event source mapping should be enabled. --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.millis(500) for Amazon MQ. The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5). > [https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching) --- ### LdapUserStoreOptions #### Initializer ```typescript import { LdapUserStoreOptions } from '@cdklabs/cdk-amazonmq' const ldapUserStoreOptions: LdapUserStoreOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | hosts | string[] | Sets the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. | | roleBase | string | The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. | | roleSearchMatching | string | The LDAP search filter used to find roles within the roleBase. | | serviceAccountPassword | aws-cdk-lib.SecretValue | Service account password. | | serviceAccountUsername | aws-cdk-lib.SecretValue | Service account username. | | userBase | string | Select a particular subtree of the directory information tree (DIT) to search for user entries. | | userRoleName | string | The name of the LDAP attribute in the user's directory entry for the user's group membership. | | userSearchMatching | string | The LDAP search filter used to find users within the userBase. | | roleName | string | The group name attribute in a role entry whose value is the name of that role. | | roleSearchSubtree | boolean | The directory search scope for the role. | | userSearchSubtree | boolean | The directory search scope for the user. | --- ##### `hosts`^Required ```typescript public readonly hosts: string[]; ``` - *Type:* string[] Sets the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory. Optional failover server. --- ##### `roleBase`^Required ```typescript public readonly roleBase: string; ``` - *Type:* string The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com. --- ##### `roleSearchMatching`^Required ```typescript public readonly roleSearchMatching: string; ``` - *Type:* string The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1}) for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the RoleBases. --- ##### `serviceAccountPassword`^Required ```typescript public readonly serviceAccountPassword: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com. --- ##### `serviceAccountUsername`^Required ```typescript public readonly serviceAccountUsername: SecretValue; ``` - *Type:* aws-cdk-lib.SecretValue Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin, ou=corp, dc=corp, dc=example, dc=com. --- ##### `userBase`^Required ```typescript public readonly userBase: string; ``` - *Type:* string Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users,ou=corp, dc=corp, dc=example, dc=com. --- ##### `userRoleName`^Required ```typescript public readonly userRoleName: string; ``` - *Type:* string The name of the LDAP attribute in the user's directory entry for the user's group membership. In some cases, user roles may be identified by the value of an attribute in the user's directory entry. The UserRoleName option allows you to provide the name of this attribute. --- ##### `userSearchMatching`^Required ```typescript public readonly userSearchMatching: string; ``` - *Type:* string The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users, ou=corp, dc=corp, dc=example, dc=com. --- ##### `roleName`^Optional ```typescript public readonly roleName: string; ``` - *Type:* string The group name attribute in a role entry whose value is the name of that role. For example, you can specify cn for a group entry's common name. If authentication succeeds, then the user is assigned the the value of the cn attribute for each role entry that they are a member of. --- ##### `roleSearchSubtree`^Optional ```typescript public readonly roleSearchSubtree: boolean; ``` - *Type:* boolean The directory search scope for the role. If set to true, scope is to search the entire subtree. --- ##### `userSearchSubtree`^Optional ```typescript public readonly userSearchSubtree: boolean; ``` - *Type:* boolean The directory search scope for the user. If set to true, scope is to search the entire subtree. --- ### MaintenanceWindowStartTime Start time of the weekly, 2-hours time window to apply pending updates or patches to the broker. #### Initializer ```typescript import { MaintenanceWindowStartTime } from '@cdklabs/cdk-amazonmq' const maintenanceWindowStartTime: MaintenanceWindowStartTime = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dayOfWeek | DayOfWeek | The day of the week. | | timeOfDay | string | The time, in 24-hour format. | | timeZone | aws-cdk-lib.TimeZone | The time zone. | --- ##### `dayOfWeek`^Required ```typescript public readonly dayOfWeek: DayOfWeek; ``` - *Type:* DayOfWeek The day of the week. --- ##### `timeOfDay`^Required ```typescript public readonly timeOfDay: string; ``` - *Type:* string The time, in 24-hour format. --- ##### `timeZone`^Required ```typescript public readonly timeZone: TimeZone; ``` - *Type:* aws-cdk-lib.TimeZone The time zone. --- ### RabbitMqApiCall A RabbitMQ Management HTTP API call. #### Initializer ```typescript import { RabbitMqApiCall } from '@cdklabs/cdk-amazonmq' const rabbitMqApiCall: RabbitMqApiCall = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | path | string | The RabbitMQ Management HTTP API call path. | | logging | aws-cdk-lib.custom_resources.Logging | A property used to configure logging during lambda function execution. | | method | HttpMethods | The HTTP Method used when invoking the RabbitMQ Management HTTP API call. | | outputPaths | string[] | Restrict the data returned by the custom resource to specific paths in the API response. | | payload | {[ key: string ]: any} | The payload expected by the RabbitMQ Management HTTP API call. | | physicalResourceId | aws-cdk-lib.custom_resources.PhysicalResourceId | The physical resource id of the custom resource for this call. | --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string The RabbitMQ Management HTTP API call path. --- ##### `logging`^Optional ```typescript public readonly logging: Logging; ``` - *Type:* aws-cdk-lib.custom_resources.Logging - *Default:* Logging.all() A property used to configure logging during lambda function execution. Note: The default Logging configuration is all. This configuration will enable logging on all logged data in the lambda handler. This includes: - The event object that is received by the lambda handler - The response received after making a API call - The response object that the lambda handler will return - SDK versioning information - Caught and uncaught errors --- ##### `method`^Optional ```typescript public readonly method: HttpMethods; ``` - *Type:* HttpMethods - *Default:* GET The HTTP Method used when invoking the RabbitMQ Management HTTP API call. --- ##### `outputPaths`^Optional ```typescript public readonly outputPaths: string[]; ``` - *Type:* string[] Restrict the data returned by the custom resource to specific paths in the API response. Use this to limit the data returned by the custom resource if working with API calls that could potentially result in custom response objects exceeding the hard limit of 4096 bytes. --- ##### `payload`^Optional ```typescript public readonly payload: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} The payload expected by the RabbitMQ Management HTTP API call. --- ##### `physicalResourceId`^Optional ```typescript public readonly physicalResourceId: PhysicalResourceId; ``` - *Type:* aws-cdk-lib.custom_resources.PhysicalResourceId - *Default:* no physical resource id The physical resource id of the custom resource for this call. Mandatory for onCreate call. In onUpdate, you can omit this to passthrough it from request. --- ### RabbitMqBrokerClusterProps #### Initializer ```typescript import { RabbitMqBrokerClusterProps } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerClusterProps: RabbitMqBrokerClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | admin | Admin | Sets the credentials of the broker administrative user. | | version | RabbitMqBrokerEngineVersion | Sets the version of the broker engine. | | cloudwatchLogsExports | RabbitMqCloudwatchLogsExports | Sets the CloudWatch logs exports for the broker. | | configuration | IRabbitMqBrokerConfiguration | Sets the configuration of the broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `admin`^Required ```typescript public readonly admin: Admin; ``` - *Type:* Admin Sets the credentials of the broker administrative user. --- ##### `version`^Required ```typescript public readonly version: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion Sets the version of the broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: RabbitMqCloudwatchLogsExports; ``` - *Type:* RabbitMqCloudwatchLogsExports Sets the CloudWatch logs exports for the broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IRabbitMqBrokerConfiguration; ``` - *Type:* IRabbitMqBrokerConfiguration Sets the configuration of the broker. --- ### RabbitMqBrokerConfigurationOptions #### Initializer ```typescript import { RabbitMqBrokerConfigurationOptions } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerConfigurationOptions: RabbitMqBrokerConfigurationOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | definition | RabbitMqBrokerConfigurationDefinition | *No description.* | | description | string | *No description.* | --- ##### `definition`^Required ```typescript public readonly definition: RabbitMqBrokerConfigurationDefinition; ``` - *Type:* RabbitMqBrokerConfigurationDefinition --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ### RabbitMqBrokerConfigurationParameters #### Initializer ```typescript import { RabbitMqBrokerConfigurationParameters } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerConfigurationParameters: RabbitMqBrokerConfigurationParameters = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | consumerTimeout | aws-cdk-lib.Duration | *No description.* | --- ##### `consumerTimeout`^Required ```typescript public readonly consumerTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration --- ### RabbitMqBrokerConfigurationProps #### Initializer ```typescript import { RabbitMqBrokerConfigurationProps } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerConfigurationProps: RabbitMqBrokerConfigurationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | definition | RabbitMqBrokerConfigurationDefinition | *No description.* | | description | string | *No description.* | | engineVersion | RabbitMqBrokerEngineVersion | *No description.* | | configurationName | string | *No description.* | --- ##### `definition`^Required ```typescript public readonly definition: RabbitMqBrokerConfigurationDefinition; ``` - *Type:* RabbitMqBrokerConfigurationDefinition --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `engineVersion`^Required ```typescript public readonly engineVersion: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ##### `configurationName`^Optional ```typescript public readonly configurationName: string; ``` - *Type:* string --- ### RabbitMqBrokerDeploymentBaseProps #### Initializer ```typescript import { RabbitMqBrokerDeploymentBaseProps } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerDeploymentBaseProps: RabbitMqBrokerDeploymentBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | admin | Admin | Sets the credentials of the broker administrative user. | | version | RabbitMqBrokerEngineVersion | Sets the version of the broker engine. | | cloudwatchLogsExports | RabbitMqCloudwatchLogsExports | Sets the CloudWatch logs exports for the broker. | | configuration | IRabbitMqBrokerConfiguration | Sets the configuration of the broker. | | deploymentMode | BrokerDeploymentMode | *No description.* | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `admin`^Required ```typescript public readonly admin: Admin; ``` - *Type:* Admin Sets the credentials of the broker administrative user. --- ##### `version`^Required ```typescript public readonly version: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion Sets the version of the broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: RabbitMqCloudwatchLogsExports; ``` - *Type:* RabbitMqCloudwatchLogsExports Sets the CloudWatch logs exports for the broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IRabbitMqBrokerConfiguration; ``` - *Type:* IRabbitMqBrokerConfiguration Sets the configuration of the broker. --- ##### `deploymentMode`^Required ```typescript public readonly deploymentMode: BrokerDeploymentMode; ``` - *Type:* BrokerDeploymentMode --- ### RabbitMqBrokerDeploymentProps #### Initializer ```typescript import { RabbitMqBrokerDeploymentProps } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerDeploymentProps: RabbitMqBrokerDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | admin | Admin | Sets the credentials of the broker administrative user. | | version | RabbitMqBrokerEngineVersion | Sets the version of the broker engine. | | cloudwatchLogsExports | RabbitMqCloudwatchLogsExports | Sets the CloudWatch logs exports for the broker. | | configuration | IRabbitMqBrokerConfiguration | Sets the configuration of the broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `admin`^Required ```typescript public readonly admin: Admin; ``` - *Type:* Admin Sets the credentials of the broker administrative user. --- ##### `version`^Required ```typescript public readonly version: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion Sets the version of the broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: RabbitMqCloudwatchLogsExports; ``` - *Type:* RabbitMqCloudwatchLogsExports Sets the CloudWatch logs exports for the broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IRabbitMqBrokerConfiguration; ``` - *Type:* IRabbitMqBrokerConfiguration Sets the configuration of the broker. --- ### RabbitMqBrokerEndpoints #### Initializer ```typescript import { RabbitMqBrokerEndpoints } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerEndpoints: RabbitMqBrokerEndpoints = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | amqp | BrokerEndpoint | *No description.* | | console | BrokerEndpoint | *No description.* | --- ##### `amqp`^Required ```typescript public readonly amqp: BrokerEndpoint; ``` - *Type:* BrokerEndpoint --- ##### `console`^Required ```typescript public readonly console: BrokerEndpoint; ``` - *Type:* BrokerEndpoint --- ### RabbitMqBrokerInstanceProps #### Initializer ```typescript import { RabbitMqBrokerInstanceProps } from '@cdklabs/cdk-amazonmq' const rabbitMqBrokerInstanceProps: RabbitMqBrokerInstanceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instanceType | aws-cdk-lib.aws_ec2.InstanceType | An instance type to use for the broker. | | publiclyAccessible | boolean | Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. | | autoMinorVersionUpgrade | boolean | Determines whether the broker will undergo a patch version upgrade during the maintenance window. | | brokerName | string | *No description.* | | cloudwatchLogsRetention | aws-cdk-lib.aws_logs.RetentionDays | Sets the retention days for the broker's CloudWatch LogGroups. | | cloudwatchLogsRetentionRole | aws-cdk-lib.aws_iam.IRole | *No description.* | | key | aws-cdk-lib.aws_kms.IKey | *No description.* | | maintenanceWindowStartTime | MaintenanceWindowStartTime | *No description.* | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The Security Groups to apply for a non publicly accessible broker. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC in which create the communication endpoints for a private broker. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | vpcSubnets and vpc are optional. | | admin | Admin | Sets the credentials of the broker administrative user. | | version | RabbitMqBrokerEngineVersion | Sets the version of the broker engine. | | cloudwatchLogsExports | RabbitMqCloudwatchLogsExports | Sets the CloudWatch logs exports for the broker. | | configuration | IRabbitMqBrokerConfiguration | Sets the configuration of the broker. | --- ##### `instanceType`^Required ```typescript public readonly instanceType: InstanceType; ``` - *Type:* aws-cdk-lib.aws_ec2.InstanceType An instance type to use for the broker. Only a subset of available instance types is allowed. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-instance-types.html) --- ##### `publiclyAccessible`^Required ```typescript public readonly publiclyAccessible: boolean; ``` - *Type:* boolean Specifies whether the broker is open to public Internet or deployed with endpoints in own VPC. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean; ``` - *Type:* boolean - *Default:* for versions with the patch version number the default is not to upgrade the patch versions; for versions withouth the patch version number patch versions are updated and this setting takes no effect. Determines whether the broker will undergo a patch version upgrade during the maintenance window. NOTE: Contrary to the name this setting does not upgrade the minor versions, but patch versions (i.e. in the X.Y.Z notation - only the Z numbers are upgraded) --- ##### `brokerName`^Optional ```typescript public readonly brokerName: string; ``` - *Type:* string --- ##### `cloudwatchLogsRetention`^Optional ```typescript public readonly cloudwatchLogsRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* undefined; CloudWatch Log Groups retention is set to never expire Sets the retention days for the broker's CloudWatch LogGroups. --- ##### `cloudwatchLogsRetentionRole`^Optional ```typescript public readonly cloudwatchLogsRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole --- ##### `key`^Optional ```typescript public readonly key: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey --- ##### `maintenanceWindowStartTime`^Optional ```typescript public readonly maintenanceWindowStartTime: MaintenanceWindowStartTime; ``` - *Type:* MaintenanceWindowStartTime --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* undefined. If no VPC is selected then a default VPC's default SG will be used. Otherwise - a security group will be created. The Security Groups to apply for a non publicly accessible broker. NOTE: This needs to be set only if `publiclyAccessible` is true. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* undefined. A default VPC will be used The VPC in which create the communication endpoints for a private broker. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* undefined. If vpc is present - this attribute must be present. vpcSubnets and vpc are optional. But when present - publiclyAccessible attribute must equal false. --- ##### `admin`^Required ```typescript public readonly admin: Admin; ``` - *Type:* Admin Sets the credentials of the broker administrative user. --- ##### `version`^Required ```typescript public readonly version: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion Sets the version of the broker engine. --- ##### `cloudwatchLogsExports`^Optional ```typescript public readonly cloudwatchLogsExports: RabbitMqCloudwatchLogsExports; ``` - *Type:* RabbitMqCloudwatchLogsExports Sets the CloudWatch logs exports for the broker. --- ##### `configuration`^Optional ```typescript public readonly configuration: IRabbitMqBrokerConfiguration; ``` - *Type:* IRabbitMqBrokerConfiguration Sets the configuration of the broker. --- ### RabbitMqCloudwatchLogsExports #### Initializer ```typescript import { RabbitMqCloudwatchLogsExports } from '@cdklabs/cdk-amazonmq' const rabbitMqCloudwatchLogsExports: RabbitMqCloudwatchLogsExports = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | general | boolean | Export general logs to CloudWatch. | --- ##### `general`^Optional ```typescript public readonly general: boolean; ``` - *Type:* boolean - *Default:* undefined; do not export general logs. Export general logs to CloudWatch. --- ### RabbitMqCustomResourceProps Properties for RabbitMqCustomResource. Note that at least onCreate, onUpdate or onDelete must be specified. #### Initializer ```typescript import { RabbitMqCustomResourceProps } from '@cdklabs/cdk-amazonmq' const rabbitMqCustomResourceProps: RabbitMqCustomResourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | broker | IRabbitMqBroker | The broker to send requests to. | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | The secret containing the broker login credentials. | | logGroup | aws-cdk-lib.aws_logs.LogGroup | The logGroup to use for the function. | | logRetention | aws-cdk-lib.aws_logs.RetentionDays | LogGroup retention to use for the function. | | onCreate | RabbitMqApiCall | The RabbitMQ Management HTTP API call to make when the resource is created. | | onDelete | RabbitMqApiCall | The RabbitMQ Management HTTP API call to make when the resource is updated. | | onUpdate | RabbitMqApiCall | The RabbitMQ Management HTTP API call to make when the resource is updated. | | policy | RabbitMqCustomResourcePolicy | The policies to attach to the function's role. | | role | aws-cdk-lib.aws_iam.IRole | The execution role for the function. | | securityGroups | aws-cdk-lib.aws_ec2.SecurityGroup[] | The security groups to assign to the function. | | timeout | aws-cdk-lib.Duration | The timeout for the custom resource. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The vpc to connect to. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | The vpc subnets to connect to. | --- ##### `broker`^Required ```typescript public readonly broker: IRabbitMqBroker; ``` - *Type:* IRabbitMqBroker The broker to send requests to. --- ##### `credentials`^Required ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret The secret containing the broker login credentials. --- ##### `logGroup`^Optional ```typescript public readonly logGroup: LogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.LogGroup The logGroup to use for the function. --- ##### ~~`logRetention`~~^Optional - *Deprecated:* use logGroup instead ```typescript public readonly logRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* RetentionDays.INFINITE LogGroup retention to use for the function. --- ##### `onCreate`^Optional ```typescript public readonly onCreate: RabbitMqApiCall; ``` - *Type:* RabbitMqApiCall - *Default:* the call when the resource is updated The RabbitMQ Management HTTP API call to make when the resource is created. --- ##### `onDelete`^Optional ```typescript public readonly onDelete: RabbitMqApiCall; ``` - *Type:* RabbitMqApiCall - *Default:* no call The RabbitMQ Management HTTP API call to make when the resource is updated. --- ##### `onUpdate`^Optional ```typescript public readonly onUpdate: RabbitMqApiCall; ``` - *Type:* RabbitMqApiCall - *Default:* no call The RabbitMQ Management HTTP API call to make when the resource is updated. --- ##### `policy`^Optional ```typescript public readonly policy: RabbitMqCustomResourcePolicy; ``` - *Type:* RabbitMqCustomResourcePolicy The policies to attach to the function's role. --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole The execution role for the function. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: SecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.SecurityGroup[] The security groups to assign to the function. --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The timeout for the custom resource. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The vpc to connect to. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection The vpc subnets to connect to. --- ### RabbitMqEventSourceProps #### Initializer ```typescript import { RabbitMqEventSourceProps } from '@cdklabs/cdk-amazonmq' const rabbitMqEventSourceProps: RabbitMqEventSourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | credentials | aws-cdk-lib.aws_secretsmanager.ISecret | A secret with credentials of the user to use when receiving messages. | | queueName | string | The name of the queue that the function will receive messages from. | | addPermissions | boolean | If the default permissions should be added to the Lambda function's execution role. | | batchSize | number | source at the time of invoking your function. | | enabled | boolean | If the stream event source mapping should be enabled. | | maxBatchingWindow | aws-cdk-lib.Duration | The maximum amount of time to gather records before invoking the function. | | broker | IRabbitMqBrokerDeployment | The RabbitMQ broker deployment to receive messages from. | | virtualHost | string | he name of the RabbitMQ virtual host from which a queue will be the source of messages. | --- ##### `credentials`^Required ```typescript public readonly credentials: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret A secret with credentials of the user to use when receiving messages. The credentials in the secret have fields required: * username * password --- ##### `queueName`^Required ```typescript public readonly queueName: string; ``` - *Type:* string The name of the queue that the function will receive messages from. --- ##### `addPermissions`^Optional ```typescript public readonly addPermissions: boolean; ``` - *Type:* boolean - *Default:* true If the default permissions should be added to the Lambda function's execution role. --- ##### `batchSize`^Optional ```typescript public readonly batchSize: number; ``` - *Type:* number - *Default:* 100 source at the time of invoking your function. Your function receives an The largest number of records that AWS Lambda will retrieve from your event event with all the retrieved records. Valid Range: * Minimum value of 1 * Maximum value of: 10000 --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the stream event source mapping should be enabled. --- ##### `maxBatchingWindow`^Optional ```typescript public readonly maxBatchingWindow: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.millis(500) for Amazon MQ. The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5). > [https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-batching) --- ##### `broker`^Required ```typescript public readonly broker: IRabbitMqBrokerDeployment; ``` - *Type:* IRabbitMqBrokerDeployment The RabbitMQ broker deployment to receive messages from. --- ##### `virtualHost`^Optional ```typescript public readonly virtualHost: string; ``` - *Type:* string - *Default:* the default virtual host '/' will be used. he name of the RabbitMQ virtual host from which a queue will be the source of messages. --- ### SimpleAuthenticationUserManagementOptions #### Initializer ```typescript import { SimpleAuthenticationUserManagementOptions } from '@cdklabs/cdk-amazonmq' const simpleAuthenticationUserManagementOptions: SimpleAuthenticationUserManagementOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | users | ActiveMqUser[] | *No description.* | --- ##### `users`^Required ```typescript public readonly users: ActiveMqUser[]; ``` - *Type:* ActiveMqUser[] --- ## Classes ### ActiveMqBrokerConfigurationDefinition #### Initializers ```typescript import { ActiveMqBrokerConfigurationDefinition } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerConfigurationDefinition(data: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | data | string | *No description.* | --- ##### `data`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | data | *No description.* | --- ##### `data` ```typescript import { ActiveMqBrokerConfigurationDefinition } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerConfigurationDefinition.data(data: string) ``` ###### `data`^Required - *Type:* string --- ### ActiveMqBrokerEngineVersion The Amazon ActiveMQ Broker Engine version. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/activemq-version-management.html) #### Initializers ```typescript import { ActiveMqBrokerEngineVersion } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerEngineVersion(version: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | version | string | *No description.* | --- ##### `version`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { ActiveMqBrokerEngineVersion } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerEngineVersion.of(version: string) ``` ###### `version`^Required - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | V5_16_7 | ActiveMqBrokerEngineVersion | *No description.* | | V5_17_6 | ActiveMqBrokerEngineVersion | it is recommended to use V5_18 instead. | | V5_18 | ActiveMqBrokerEngineVersion | *No description.* | --- ##### ~~`V5_16_7`~~^Required - *Deprecated:* use V5_18 instead ```typescript public readonly V5_16_7: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion --- ##### `V5_17_6`^Required ```typescript public readonly V5_17_6: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion it is recommended to use V5_18 instead. --- ##### `V5_18`^Required ```typescript public readonly V5_18: ActiveMqBrokerEngineVersion; ``` - *Type:* ActiveMqBrokerEngineVersion --- ### ActiveMqBrokerUserManagement #### Initializers ```typescript import { ActiveMqBrokerUserManagement } from '@cdklabs/cdk-amazonmq' new ActiveMqBrokerUserManagement() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | ldap | *No description.* | | simple | *No description.* | --- ##### `ldap` ```typescript import { ActiveMqBrokerUserManagement } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerUserManagement.ldap(options: LdapUserStoreOptions) ``` ###### `options`^Required - *Type:* LdapUserStoreOptions --- ##### `simple` ```typescript import { ActiveMqBrokerUserManagement } from '@cdklabs/cdk-amazonmq' ActiveMqBrokerUserManagement.simple(options: SimpleAuthenticationUserManagementOptions) ``` ###### `options`^Required - *Type:* SimpleAuthenticationUserManagementOptions --- ### ActiveMqEventSource - *Implements:* aws-cdk-lib.aws_lambda.IEventSource Represents an AWS Lambda Event Source Mapping for ActiveMQ. This event source will add additional permissions to the AWS Lambda function's IAM Role following https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions #### Initializers ```typescript import { ActiveMqEventSource } from '@cdklabs/cdk-amazonmq' new ActiveMqEventSource(props: ActiveMqEventSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ActiveMqEventSourceProps | properties of the ActiveMQ event source. | --- ##### `props`^Required - *Type:* ActiveMqEventSourceProps properties of the ActiveMQ event source. --- #### Methods | **Name** | **Description** | | --- | --- | | bind | Called by `lambda.addEventSource` to allow the event source to bind to this function. | --- ##### `bind` ```typescript public bind(target: IFunction): void ``` Called by `lambda.addEventSource` to allow the event source to bind to this function. ###### `target`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ### EventSourceBase - *Implements:* aws-cdk-lib.aws_lambda.IEventSource Represents an AWS Lambda Event Source Mapping for RabbitMQ. This event source will add additional permissions to the AWS Lambda function's IAM Role following https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions #### Initializers ```typescript import { EventSourceBase } from '@cdklabs/cdk-amazonmq' new EventSourceBase(props: EventSourceBaseProps, mqType: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | EventSourceBaseProps | properties of the RabbitMQ event source. | | mqType | string | *No description.* | --- ##### `props`^Required - *Type:* EventSourceBaseProps properties of the RabbitMQ event source. --- ##### `mqType`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | bind | Called by `lambda.addEventSource` to allow the event source to bind to this function. | --- ##### `bind` ```typescript public bind(target: IFunction): void ``` Called by `lambda.addEventSource` to allow the event source to bind to this function. ###### `target`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ### RabbitMqBrokerConfigurationDefinition #### Initializers ```typescript import { RabbitMqBrokerConfigurationDefinition } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerConfigurationDefinition(data: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | data | string | *No description.* | --- ##### `data`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | data | *No description.* | | parameters | *No description.* | --- ##### `data` ```typescript import { RabbitMqBrokerConfigurationDefinition } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfigurationDefinition.data(data: string) ``` ###### `data`^Required - *Type:* string --- ##### `parameters` ```typescript import { RabbitMqBrokerConfigurationDefinition } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerConfigurationDefinition.parameters(parameters: RabbitMqBrokerConfigurationParameters) ``` ###### `parameters`^Required - *Type:* RabbitMqBrokerConfigurationParameters --- ### RabbitMqBrokerEngineVersion The Amazon RabbitMQ Broker Engine version. > [https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-version-management.html) #### Initializers ```typescript import { RabbitMqBrokerEngineVersion } from '@cdklabs/cdk-amazonmq' new RabbitMqBrokerEngineVersion(version: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | version | string | *No description.* | --- ##### `version`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { RabbitMqBrokerEngineVersion } from '@cdklabs/cdk-amazonmq' RabbitMqBrokerEngineVersion.of(version: string) ``` ###### `version`^Required - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | V3_11_16 | RabbitMqBrokerEngineVersion | *No description.* | | V3_11_20 | RabbitMqBrokerEngineVersion | *No description.* | | V3_11_28 | RabbitMqBrokerEngineVersion | *No description.* | | V3_12_13 | RabbitMqBrokerEngineVersion | *No description.* | | V3_13 | RabbitMqBrokerEngineVersion | *No description.* | --- ##### ~~`V3_11_16`~~^Required - *Deprecated:* use V3_13 instead ```typescript public readonly V3_11_16: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ##### ~~`V3_11_20`~~^Required - *Deprecated:* use V3_13 instead ```typescript public readonly V3_11_20: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ##### ~~`V3_11_28`~~^Required - *Deprecated:* use V3_13 instead ```typescript public readonly V3_11_28: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ##### ~~`V3_12_13`~~^Required - *Deprecated:* use V3_13 instead ```typescript public readonly V3_12_13: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ##### `V3_13`^Required ```typescript public readonly V3_13: RabbitMqBrokerEngineVersion; ``` - *Type:* RabbitMqBrokerEngineVersion --- ### RabbitMqCustomResourcePolicy The IAM Policy that will be applied to the calls. #### Static Functions | **Name** | **Description** | | --- | --- | | fromStatements | Explicit IAM Policy Statements. | --- ##### `fromStatements` ```typescript import { RabbitMqCustomResourcePolicy } from '@cdklabs/cdk-amazonmq' RabbitMqCustomResourcePolicy.fromStatements(statements: PolicyStatement[]) ``` Explicit IAM Policy Statements. ###### `statements`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] the statements to propagate to the SDK calls. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | statements | aws-cdk-lib.aws_iam.PolicyStatement[] | statements for explicit policy. | --- ##### `statements`^Required ```typescript public readonly statements: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] statements for explicit policy. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANY_RESOURCE | string[] | Use this constant to configure access to any resource. | --- ##### `ANY_RESOURCE`^Required ```typescript public readonly ANY_RESOURCE: string[]; ``` - *Type:* string[] Use this constant to configure access to any resource. --- ### RabbitMqEventSource - *Implements:* aws-cdk-lib.aws_lambda.IEventSource Represents an AWS Lambda Event Source Mapping for RabbitMQ. This event source will add additional permissions to the AWS Lambda function's IAM Role following https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#events-mq-permissions #### Initializers ```typescript import { RabbitMqEventSource } from '@cdklabs/cdk-amazonmq' new RabbitMqEventSource(props: RabbitMqEventSourceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RabbitMqEventSourceProps | properties of the RabbitMQ event source. | --- ##### `props`^Required - *Type:* RabbitMqEventSourceProps properties of the RabbitMQ event source. --- #### Methods | **Name** | **Description** | | --- | --- | | bind | Called by `lambda.addEventSource` to allow the event source to bind to this function. | --- ##### `bind` ```typescript public bind(target: IFunction): void ``` Called by `lambda.addEventSource` to allow the event source to bind to this function. ###### `target`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ## Protocols ### IActiveMqBroker - *Implemented By:* ActiveMqBrokerInstance, IActiveMqBroker, IActiveMqBrokerInstance #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoints | ActiveMqBrokerEndpoints | A set of endpoints for the broker. | | ipAddress | string | The IP address of the broker. | --- ##### `endpoints`^Required ```typescript public readonly endpoints: ActiveMqBrokerEndpoints; ``` - *Type:* ActiveMqBrokerEndpoints A set of endpoints for the broker. --- ##### `ipAddress`^Required ```typescript public readonly ipAddress: string; ``` - *Type:* string The IP address of the broker. --- ### IActiveMqBrokerConfiguration - *Extends:* IBrokerConfiguration - *Implemented By:* IActiveMqBrokerConfiguration #### Methods | **Name** | **Description** | | --- | --- | | associateWith | *No description.* | | createRevision | *No description.* | --- ##### `associateWith` ```typescript public associateWith(broker: IActiveMqBrokerDeployment): ConfigurationAssociation ``` ###### `broker`^Required - *Type:* IActiveMqBrokerDeployment --- ##### `createRevision` ```typescript public createRevision(options: ActiveMqBrokerConfigurationOptions): IActiveMqBrokerConfiguration ``` ###### `options`^Required - *Type:* ActiveMqBrokerConfigurationOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### IActiveMqBrokerDeployment - *Extends:* aws-cdk-lib.IResource, IBrokerDeployment - *Implemented By:* ActiveMqBrokerDeploymentBase, ActiveMqBrokerInstance, ActiveMqBrokerRedundantPair, IActiveMqBrokerDeployment, IActiveMqBrokerInstance, IActiveMqBrokerRedundantPair #### Methods | **Name** | **Description** | | --- | --- | | metricAmqpMaximumConnections | *No description.* | | metricBurstBalance | *No description.* | | metricConsumerCount | *No description.* | | metricCpuCreditBalance | *No description.* | | metricCpuUtilization | *No description.* | | metricCurrentConnectionsCount | *No description.* | | metricDequeueCount | *No description.* | | metricDispatchCount | *No description.* | | metricEnqueueCount | *No description.* | | metricEnqueueTime | *No description.* | | metricEstablishedConnectionsCount | *No description.* | | metricExpiredCount | *No description.* | | metricHeapUsage | *No description.* | | metricInactiveDurableTopicSubscribersCount | *No description.* | | metricInFlightCount | *No description.* | | metricJobSchedulerStorePercentUsage | *No description.* | | metricJournalFilesForFastRecovery | *No description.* | | metricJournalFilesForFullRecovery | *No description.* | | metricMemoryUsage | *No description.* | | metricMqttMaximumConnections | *No description.* | | metricNetworkConnectorConnectionCount | *No description.* | | metricNetworkIn | *No description.* | | metricNetworkOut | *No description.* | | metricOpenTransactionCount | *No description.* | | metricOpenwireMaximumConnections | *No description.* | | metricProducerCount | *No description.* | | metricQueueSize | *No description.* | | metricReceiveCount | *No description.* | | metricStompMaximumConnections | *No description.* | | metricStorePercentUsage | *No description.* | | metricTempPercentUsage | *No description.* | | metricTotalConsumerCount | *No description.* | | metricTotalDequeueCount | *No description.* | | metricTotalEnqueueCount | *No description.* | | metricTotalMessageCount | *No description.* | | metricTotalProducerCount | *No description.* | | metricVolumeReadOps | *No description.* | | metricVolumeWriteOps | *No description.* | | metricWsMaximumConnections | *No description.* | --- ##### `metricAmqpMaximumConnections` ```typescript public metricAmqpMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBurstBalance` ```typescript public metricBurstBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuCreditBalance` ```typescript public metricCpuCreditBalance(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuUtilization` ```typescript public metricCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCurrentConnectionsCount` ```typescript public metricCurrentConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDequeueCount` ```typescript public metricDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDispatchCount` ```typescript public metricDispatchCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueCount` ```typescript public metricEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEnqueueTime` ```typescript public metricEnqueueTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEstablishedConnectionsCount` ```typescript public metricEstablishedConnectionsCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExpiredCount` ```typescript public metricExpiredCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricHeapUsage` ```typescript public metricHeapUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInactiveDurableTopicSubscribersCount` ```typescript public metricInactiveDurableTopicSubscribersCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInFlightCount` ```typescript public metricInFlightCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJobSchedulerStorePercentUsage` ```typescript public metricJobSchedulerStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFastRecovery` ```typescript public metricJournalFilesForFastRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJournalFilesForFullRecovery` ```typescript public metricJournalFilesForFullRecovery(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMemoryUsage` ```typescript public metricMemoryUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMqttMaximumConnections` ```typescript public metricMqttMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkConnectorConnectionCount` ```typescript public metricNetworkConnectorConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkIn` ```typescript public metricNetworkIn(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkOut` ```typescript public metricNetworkOut(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenTransactionCount` ```typescript public metricOpenTransactionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOpenwireMaximumConnections` ```typescript public metricOpenwireMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricProducerCount` ```typescript public metricProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueSize` ```typescript public metricQueueSize(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricReceiveCount` ```typescript public metricReceiveCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStompMaximumConnections` ```typescript public metricStompMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStorePercentUsage` ```typescript public metricStorePercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTempPercentUsage` ```typescript public metricTempPercentUsage(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalConsumerCount` ```typescript public metricTotalConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalDequeueCount` ```typescript public metricTotalDequeueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalEnqueueCount` ```typescript public metricTotalEnqueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalMessageCount` ```typescript public metricTotalMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalProducerCount` ```typescript public metricTotalProducerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeReadOps` ```typescript public metricVolumeReadOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeWriteOps` ```typescript public metricVolumeWriteOps(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricWsMaximumConnections` ```typescript public metricWsMaximumConnections(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ### IActiveMqBrokerInstance - *Extends:* IActiveMqBrokerDeployment, IActiveMqBroker - *Implemented By:* ActiveMqBrokerInstance, IActiveMqBrokerInstance #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | | endpoints | ActiveMqBrokerEndpoints | A set of endpoints for the broker. | | ipAddress | string | The IP address of the broker. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ##### `endpoints`^Required ```typescript public readonly endpoints: ActiveMqBrokerEndpoints; ``` - *Type:* ActiveMqBrokerEndpoints A set of endpoints for the broker. --- ##### `ipAddress`^Required ```typescript public readonly ipAddress: string; ``` - *Type:* string The IP address of the broker. --- ### IActiveMqBrokerRedundantPair - *Extends:* IActiveMqBrokerDeployment - *Implemented By:* ActiveMqBrokerRedundantPair, IActiveMqBrokerRedundantPair #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | | first | IActiveMqBroker | *No description.* | | second | IActiveMqBroker | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ##### `first`^Required ```typescript public readonly first: IActiveMqBroker; ``` - *Type:* IActiveMqBroker --- ##### `second`^Required ```typescript public readonly second: IActiveMqBroker; ``` - *Type:* IActiveMqBroker --- ### IActiveMqBrokerUserManagement - *Implemented By:* IActiveMqBrokerUserManagement #### Methods | **Name** | **Description** | | --- | --- | | render | *No description.* | --- ##### `render` ```typescript public render(): ActiveMqBrokerDeploymentUserManagementDefinition ``` ### IBrokerConfiguration - *Extends:* aws-cdk-lib.IResource - *Implemented By:* ActiveMqBrokerConfiguration, BrokerConfiguration, RabbitMqBrokerConfiguration, IActiveMqBrokerConfiguration, IBrokerConfiguration, IRabbitMqBrokerConfiguration #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### IBrokerDeployment - *Extends:* aws-cdk-lib.IResource - *Implemented By:* ActiveMqBrokerDeploymentBase, ActiveMqBrokerInstance, ActiveMqBrokerRedundantPair, BrokerDeploymentBase, RabbitMqBrokerCluster, RabbitMqBrokerDeploymentBase, RabbitMqBrokerInstance, IActiveMqBrokerDeployment, IActiveMqBrokerInstance, IActiveMqBrokerRedundantPair, IBrokerDeployment, IRabbitMqBrokerCluster, IRabbitMqBrokerDeployment, IRabbitMqBrokerInstance #### Methods | **Name** | **Description** | | --- | --- | | metric | *No description.* | --- ##### `metric` ```typescript public metric(metricName: string, options?: MetricOptions): Metric ``` ###### `metricName`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ### IRabbitMqBroker - *Extends:* aws-cdk-lib.IResource - *Implemented By:* RabbitMqBrokerCluster, RabbitMqBrokerDeploymentBase, RabbitMqBrokerInstance, IRabbitMqBroker, IRabbitMqBrokerCluster, IRabbitMqBrokerInstance #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | endpoints | RabbitMqBrokerEndpoints | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ### IRabbitMqBrokerCluster - *Extends:* IRabbitMqBroker, IRabbitMqBrokerDeployment - *Implemented By:* RabbitMqBrokerCluster, IRabbitMqBrokerCluster #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | endpoints | RabbitMqBrokerEndpoints | *No description.* | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ### IRabbitMqBrokerConfiguration - *Extends:* IBrokerConfiguration - *Implemented By:* IRabbitMqBrokerConfiguration #### Methods | **Name** | **Description** | | --- | --- | | associateWith | *No description.* | | createRevision | *No description.* | --- ##### `associateWith` ```typescript public associateWith(broker: IRabbitMqBrokerDeployment): ConfigurationAssociation ``` ###### `broker`^Required - *Type:* IRabbitMqBrokerDeployment --- ##### `createRevision` ```typescript public createRevision(options: RabbitMqBrokerConfigurationOptions): IRabbitMqBrokerConfiguration ``` ###### `options`^Required - *Type:* RabbitMqBrokerConfigurationOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | revision | number | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `revision`^Required ```typescript public readonly revision: number; ``` - *Type:* number --- ### IRabbitMqBrokerDeployment - *Extends:* aws-cdk-lib.IResource, IBrokerDeployment - *Implemented By:* RabbitMqBrokerCluster, RabbitMqBrokerDeploymentBase, RabbitMqBrokerInstance, IRabbitMqBrokerCluster, IRabbitMqBrokerDeployment, IRabbitMqBrokerInstance #### Methods | **Name** | **Description** | | --- | --- | | metricAckRate | *No description.* | | metricChannelCount | *No description.* | | metricConfirmRate | *No description.* | | metricConnectionCount | *No description.* | | metricConsumerCount | *No description.* | | metricExchangeCount | *No description.* | | metricMessageCount | *No description.* | | metricMessageReadyCount | *No description.* | | metricMessageUnacknowledgedCount | *No description.* | | metricPublishRate | *No description.* | | metricQueueCount | *No description.* | | metricRabbitMQDiskFree | *No description.* | | metricRabbitMQDiskFreeLimit | *No description.* | | metricRabbitMQFdUsed | *No description.* | | metricRabbitMQIOReadAverageTime | *No description.* | | metricRabbitMQIOWriteAverageTime | *No description.* | | metricRabbitMQMemLimit | *No description.* | | metricRabbitMQMemUsed | *No description.* | | metricSystemCpuUtilization | *No description.* | --- ##### `metricAckRate` ```typescript public metricAckRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricChannelCount` ```typescript public metricChannelCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConfirmRate` ```typescript public metricConfirmRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConnectionCount` ```typescript public metricConnectionCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumerCount` ```typescript public metricConsumerCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricExchangeCount` ```typescript public metricExchangeCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageCount` ```typescript public metricMessageCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageReadyCount` ```typescript public metricMessageReadyCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMessageUnacknowledgedCount` ```typescript public metricMessageUnacknowledgedCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricPublishRate` ```typescript public metricPublishRate(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricQueueCount` ```typescript public metricQueueCount(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFree` ```typescript public metricRabbitMQDiskFree(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQDiskFreeLimit` ```typescript public metricRabbitMQDiskFreeLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQFdUsed` ```typescript public metricRabbitMQFdUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOReadAverageTime` ```typescript public metricRabbitMQIOReadAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQIOWriteAverageTime` ```typescript public metricRabbitMQIOWriteAverageTime(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemLimit` ```typescript public metricRabbitMQMemLimit(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRabbitMQMemUsed` ```typescript public metricRabbitMQMemUsed(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSystemCpuUtilization` ```typescript public metricSystemCpuUtilization(props?: MetricOptions): Metric ``` ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ### IRabbitMqBrokerInstance - *Extends:* IRabbitMqBrokerDeployment, IRabbitMqBroker - *Implemented By:* RabbitMqBrokerInstance, IRabbitMqBrokerInstance #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | arn | string | *No description.* | | id | string | *No description.* | | name | string | *No description.* | | connections | aws-cdk-lib.aws_ec2.Connections | *No description.* | | endpoints | RabbitMqBrokerEndpoints | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `arn`^Required ```typescript public readonly arn: string; ``` - *Type:* string --- ##### `id`^Required ```typescript public readonly id: string; ``` - *Type:* string --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ##### `connections`^Optional ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections --- ##### `endpoints`^Required ```typescript public readonly endpoints: RabbitMqBrokerEndpoints; ``` - *Type:* RabbitMqBrokerEndpoints --- ## Enums ### ActiveMqAuthenticationStrategy Amazon MQ for ActiveMQ's authentication strategy. #### Members | **Name** | **Description** | | --- | --- | | SIMPLE | *No description.* | | LDAP | *No description.* | --- ##### `SIMPLE` --- ##### `LDAP` --- ### BrokerDeploymentMode #### Members | **Name** | **Description** | | --- | --- | | CLUSTER_MULTI_AZ | *No description.* | | SINGLE_INSTANCE | *No description.* | | ACTIVE_STANDBY_MULTI_AZ | *No description.* | --- ##### `CLUSTER_MULTI_AZ` --- ##### `SINGLE_INSTANCE` --- ##### `ACTIVE_STANDBY_MULTI_AZ` --- ### BrokerEngine #### Members | **Name** | **Description** | | --- | --- | | RABBITMQ | *No description.* | | ACTIVEMQ | *No description.* | --- ##### `RABBITMQ` --- ##### `ACTIVEMQ` --- ### DayOfWeek #### Members | **Name** | **Description** | | --- | --- | | MONDAY | *No description.* | | TUESDAY | *No description.* | | WEDNESDAY | *No description.* | | THURSDAY | *No description.* | | FRIDAY | *No description.* | | SATURDAY | *No description.* | | SUNDAY | *No description.* | --- ##### `MONDAY` --- ##### `TUESDAY` --- ##### `WEDNESDAY` --- ##### `THURSDAY` --- ##### `FRIDAY` --- ##### `SATURDAY` --- ##### `SUNDAY` --- ### HttpMethods All http request methods. #### Members | **Name** | **Description** | | --- | --- | | GET | *No description.* | | POST | *No description.* | | PUT | *No description.* | | DELETE | *No description.* | --- ##### `GET` --- ##### `POST` --- ##### `PUT` --- ##### `DELETE` --- ### StorageType #### Members | **Name** | **Description** | | --- | --- | | EBS | Amazon Elastic Block Store. | | EFS | *No description.* | --- ##### `EBS` Amazon Elastic Block Store. NOTE: Available only for single-instance ActiveMQ brokers --- ##### `EFS` ---