@cdklabs/cdk-amazonmq
Version:
<!--BEGIN STABILITY BANNER-->
1,185 lines (733 loc) • 563 kB
Markdown
# API Reference <a name="API Reference" id="api-reference"></a>
## Constructs <a name="Constructs" id="Constructs"></a>
### ActiveMqBrokerConfiguration <a name="ActiveMqBrokerConfiguration" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration"></a>
#### Initializers <a name="Initializers" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer"></a>
```typescript
import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq'
new ActiveMqBrokerConfiguration(scope: Construct, id: string, props: ActiveMqBrokerConfigurationProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfigurationProps">ActiveMqBrokerConfigurationProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.Initializer.parameter.props"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfigurationProps">ActiveMqBrokerConfigurationProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.with">with</a></code> | Applies one or more mixins to this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.associateWith">associateWith</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.createRevision">createRevision</a></code> | *No description.* |
---
##### `toString` <a name="toString" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with` <a name="with" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.with"></a>
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`<sup>Required</sup> <a name="mixins" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.with.parameter.mixins"></a>
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.applyRemovalPolicy"></a>
```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`<sup>Required</sup> <a name="policy" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `associateWith` <a name="associateWith" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.associateWith"></a>
```typescript
public associateWith(broker: IActiveMqBrokerDeployment): ConfigurationAssociation
```
###### `broker`<sup>Required</sup> <a name="broker" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.associateWith.parameter.broker"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.IActiveMqBrokerDeployment">IActiveMqBrokerDeployment</a>
---
##### ~~`createRevision`~~ <a name="createRevision" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.createRevision"></a>
```typescript
public createRevision(options: ActiveMqBrokerConfigurationOptions): IActiveMqBrokerConfiguration
```
###### `options`<sup>Required</sup> <a name="options" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.createRevision.parameter.options"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfigurationOptions">ActiveMqBrokerConfigurationOptions</a>
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.fromAttributes">fromAttributes</a></code> | *No description.* |
---
##### `isConstruct` <a name="isConstruct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isConstruct"></a>
```typescript
import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerConfiguration.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isOwnedResource"></a>
```typescript
import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerConfiguration.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isResource"></a>
```typescript
import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerConfiguration.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `fromAttributes` <a name="fromAttributes" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.fromAttributes"></a>
```typescript
import { ActiveMqBrokerConfiguration } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerConfiguration.fromAttributes(scope: Construct, logicalId: string, attrs: BrokerConfigurationAttributes)
```
###### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.fromAttributes.parameter.scope"></a>
- *Type:* constructs.Construct
---
###### `logicalId`<sup>Required</sup> <a name="logicalId" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.fromAttributes.parameter.logicalId"></a>
- *Type:* string
---
###### `attrs`<sup>Required</sup> <a name="attrs" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.fromAttributes.parameter.attrs"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.BrokerConfigurationAttributes">BrokerConfigurationAttributes</a>
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.arn">arn</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.revision">revision</a></code> | <code>number</code> | *No description.* |
---
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`<sup>Required</sup> <a name="env" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.env"></a>
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
different than the stack they were imported into.
---
##### `stack`<sup>Required</sup> <a name="stack" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.stack"></a>
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `arn`<sup>Required</sup> <a name="arn" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.arn"></a>
```typescript
public readonly arn: string;
```
- *Type:* string
---
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.id"></a>
```typescript
public readonly id: string;
```
- *Type:* string
---
##### `revision`<sup>Required</sup> <a name="revision" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerConfiguration.property.revision"></a>
```typescript
public readonly revision: number;
```
- *Type:* number
---
### ActiveMqBrokerDeploymentBase <a name="ActiveMqBrokerDeploymentBase" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase"></a>
- *Implements:* <a href="#@cdklabs/cdk-amazonmq.IActiveMqBrokerDeployment">IActiveMqBrokerDeployment</a>
#### Initializers <a name="Initializers" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer"></a>
```typescript
import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq'
new ActiveMqBrokerDeploymentBase(scope: Construct, id: string, props: ActiveMqBrokerDeploymentBaseProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBaseProps">ActiveMqBrokerDeploymentBaseProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.Initializer.parameter.props"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBaseProps">ActiveMqBrokerDeploymentBaseProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.with">with</a></code> | Applies one or more mixins to this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metric">metric</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricAmqpMaximumConnections">metricAmqpMaximumConnections</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricBurstBalance">metricBurstBalance</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricConsumerCount">metricConsumerCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuCreditBalance">metricCpuCreditBalance</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuUtilization">metricCpuUtilization</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCurrentConnectionsCount">metricCurrentConnectionsCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDequeueCount">metricDequeueCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDispatchCount">metricDispatchCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueCount">metricEnqueueCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueTime">metricEnqueueTime</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEstablishedConnectionsCount">metricEstablishedConnectionsCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricExpiredCount">metricExpiredCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricHeapUsage">metricHeapUsage</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInactiveDurableTopicSubscribersCount">metricInactiveDurableTopicSubscribersCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInFlightCount">metricInFlightCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJobSchedulerStorePercentUsage">metricJobSchedulerStorePercentUsage</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFastRecovery">metricJournalFilesForFastRecovery</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFullRecovery">metricJournalFilesForFullRecovery</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMemoryUsage">metricMemoryUsage</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMqttMaximumConnections">metricMqttMaximumConnections</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkConnectorConnectionCount">metricNetworkConnectorConnectionCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkIn">metricNetworkIn</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkOut">metricNetworkOut</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenTransactionCount">metricOpenTransactionCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenwireMaximumConnections">metricOpenwireMaximumConnections</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricProducerCount">metricProducerCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricQueueSize">metricQueueSize</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricReceiveCount">metricReceiveCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStompMaximumConnections">metricStompMaximumConnections</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStorePercentUsage">metricStorePercentUsage</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTempPercentUsage">metricTempPercentUsage</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalConsumerCount">metricTotalConsumerCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalDequeueCount">metricTotalDequeueCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalEnqueueCount">metricTotalEnqueueCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalMessageCount">metricTotalMessageCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalProducerCount">metricTotalProducerCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeReadOps">metricVolumeReadOps</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeWriteOps">metricVolumeWriteOps</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricWsMaximumConnections">metricWsMaximumConnections</a></code> | *No description.* |
---
##### `toString` <a name="toString" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.toString"></a>
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with` <a name="with" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.with"></a>
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`<sup>Required</sup> <a name="mixins" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.with.parameter.mixins"></a>
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.applyRemovalPolicy"></a>
```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`<sup>Required</sup> <a name="policy" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.applyRemovalPolicy.parameter.policy"></a>
- *Type:* aws-cdk-lib.RemovalPolicy
---
##### `metric` <a name="metric" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metric"></a>
```typescript
public metric(metricName: string, options?: MetricOptions): Metric
```
###### `metricName`<sup>Required</sup> <a name="metricName" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metric.parameter.metricName"></a>
- *Type:* string
---
###### `options`<sup>Optional</sup> <a name="options" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metric.parameter.options"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricAmqpMaximumConnections` <a name="metricAmqpMaximumConnections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricAmqpMaximumConnections"></a>
```typescript
public metricAmqpMaximumConnections(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricAmqpMaximumConnections.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricBurstBalance` <a name="metricBurstBalance" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricBurstBalance"></a>
```typescript
public metricBurstBalance(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricBurstBalance.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricConsumerCount` <a name="metricConsumerCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricConsumerCount"></a>
```typescript
public metricConsumerCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricConsumerCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricCpuCreditBalance` <a name="metricCpuCreditBalance" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuCreditBalance"></a>
```typescript
public metricCpuCreditBalance(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuCreditBalance.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricCpuUtilization` <a name="metricCpuUtilization" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuUtilization"></a>
```typescript
public metricCpuUtilization(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCpuUtilization.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricCurrentConnectionsCount` <a name="metricCurrentConnectionsCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCurrentConnectionsCount"></a>
```typescript
public metricCurrentConnectionsCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricCurrentConnectionsCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricDequeueCount` <a name="metricDequeueCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDequeueCount"></a>
```typescript
public metricDequeueCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDequeueCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricDispatchCount` <a name="metricDispatchCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDispatchCount"></a>
```typescript
public metricDispatchCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricDispatchCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricEnqueueCount` <a name="metricEnqueueCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueCount"></a>
```typescript
public metricEnqueueCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricEnqueueTime` <a name="metricEnqueueTime" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueTime"></a>
```typescript
public metricEnqueueTime(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEnqueueTime.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricEstablishedConnectionsCount` <a name="metricEstablishedConnectionsCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEstablishedConnectionsCount"></a>
```typescript
public metricEstablishedConnectionsCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricEstablishedConnectionsCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricExpiredCount` <a name="metricExpiredCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricExpiredCount"></a>
```typescript
public metricExpiredCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricExpiredCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricHeapUsage` <a name="metricHeapUsage" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricHeapUsage"></a>
```typescript
public metricHeapUsage(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricHeapUsage.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricInactiveDurableTopicSubscribersCount` <a name="metricInactiveDurableTopicSubscribersCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInactiveDurableTopicSubscribersCount"></a>
```typescript
public metricInactiveDurableTopicSubscribersCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInactiveDurableTopicSubscribersCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricInFlightCount` <a name="metricInFlightCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInFlightCount"></a>
```typescript
public metricInFlightCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricInFlightCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricJobSchedulerStorePercentUsage` <a name="metricJobSchedulerStorePercentUsage" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJobSchedulerStorePercentUsage"></a>
```typescript
public metricJobSchedulerStorePercentUsage(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJobSchedulerStorePercentUsage.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricJournalFilesForFastRecovery` <a name="metricJournalFilesForFastRecovery" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFastRecovery"></a>
```typescript
public metricJournalFilesForFastRecovery(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFastRecovery.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricJournalFilesForFullRecovery` <a name="metricJournalFilesForFullRecovery" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFullRecovery"></a>
```typescript
public metricJournalFilesForFullRecovery(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricJournalFilesForFullRecovery.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricMemoryUsage` <a name="metricMemoryUsage" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMemoryUsage"></a>
```typescript
public metricMemoryUsage(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMemoryUsage.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricMqttMaximumConnections` <a name="metricMqttMaximumConnections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMqttMaximumConnections"></a>
```typescript
public metricMqttMaximumConnections(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricMqttMaximumConnections.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricNetworkConnectorConnectionCount` <a name="metricNetworkConnectorConnectionCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkConnectorConnectionCount"></a>
```typescript
public metricNetworkConnectorConnectionCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkConnectorConnectionCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricNetworkIn` <a name="metricNetworkIn" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkIn"></a>
```typescript
public metricNetworkIn(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkIn.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricNetworkOut` <a name="metricNetworkOut" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkOut"></a>
```typescript
public metricNetworkOut(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricNetworkOut.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricOpenTransactionCount` <a name="metricOpenTransactionCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenTransactionCount"></a>
```typescript
public metricOpenTransactionCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenTransactionCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricOpenwireMaximumConnections` <a name="metricOpenwireMaximumConnections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenwireMaximumConnections"></a>
```typescript
public metricOpenwireMaximumConnections(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricOpenwireMaximumConnections.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricProducerCount` <a name="metricProducerCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricProducerCount"></a>
```typescript
public metricProducerCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricProducerCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricQueueSize` <a name="metricQueueSize" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricQueueSize"></a>
```typescript
public metricQueueSize(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricQueueSize.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricReceiveCount` <a name="metricReceiveCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricReceiveCount"></a>
```typescript
public metricReceiveCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricReceiveCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricStompMaximumConnections` <a name="metricStompMaximumConnections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStompMaximumConnections"></a>
```typescript
public metricStompMaximumConnections(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStompMaximumConnections.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricStorePercentUsage` <a name="metricStorePercentUsage" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStorePercentUsage"></a>
```typescript
public metricStorePercentUsage(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricStorePercentUsage.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTempPercentUsage` <a name="metricTempPercentUsage" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTempPercentUsage"></a>
```typescript
public metricTempPercentUsage(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTempPercentUsage.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTotalConsumerCount` <a name="metricTotalConsumerCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalConsumerCount"></a>
```typescript
public metricTotalConsumerCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalConsumerCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTotalDequeueCount` <a name="metricTotalDequeueCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalDequeueCount"></a>
```typescript
public metricTotalDequeueCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalDequeueCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTotalEnqueueCount` <a name="metricTotalEnqueueCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalEnqueueCount"></a>
```typescript
public metricTotalEnqueueCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalEnqueueCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTotalMessageCount` <a name="metricTotalMessageCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalMessageCount"></a>
```typescript
public metricTotalMessageCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalMessageCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricTotalProducerCount` <a name="metricTotalProducerCount" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalProducerCount"></a>
```typescript
public metricTotalProducerCount(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricTotalProducerCount.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricVolumeReadOps` <a name="metricVolumeReadOps" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeReadOps"></a>
```typescript
public metricVolumeReadOps(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeReadOps.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricVolumeWriteOps` <a name="metricVolumeWriteOps" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeWriteOps"></a>
```typescript
public metricVolumeWriteOps(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricVolumeWriteOps.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
##### `metricWsMaximumConnections` <a name="metricWsMaximumConnections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricWsMaximumConnections"></a>
```typescript
public metricWsMaximumConnections(props?: MetricOptions): Metric
```
###### `props`<sup>Optional</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.metricWsMaximumConnections.parameter.props"></a>
- *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions
---
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
---
##### `isConstruct` <a name="isConstruct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isConstruct"></a>
```typescript
import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerDeploymentBase.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`<sup>Required</sup> <a name="x" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isConstruct.parameter.x"></a>
- *Type:* any
Any object.
---
##### `isOwnedResource` <a name="isOwnedResource" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isOwnedResource"></a>
```typescript
import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerDeploymentBase.isOwnedResource(construct: IConstruct)
```
Returns true if the construct was created by CDK, and false otherwise.
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isOwnedResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
##### `isResource` <a name="isResource" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isResource"></a>
```typescript
import { ActiveMqBrokerDeploymentBase } from '@cdklabs/cdk-amazonmq'
ActiveMqBrokerDeploymentBase.isResource(construct: IConstruct)
```
Check whether the given construct is a Resource.
###### `construct`<sup>Required</sup> <a name="construct" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.isResource.parameter.construct"></a>
- *Type:* constructs.IConstruct
---
#### Properties <a name="Properties" id="Properties"></a>
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.arn">arn</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.name">name</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | Manages connections for the cluster. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.configuration">configuration</a></code> | <code><a href="#@cdklabs/cdk-amazonmq.IActiveMqBrokerConfiguration">IActiveMqBrokerConfiguration</a></code> | *No description.* |
---
##### `node`<sup>Required</sup> <a name="node" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.node"></a>
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `env`<sup>Required</sup> <a name="env" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.env"></a>
```typescript
public readonly env: ResourceEnvironment;
```
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed in a Stack (those created by
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
different than the stack they were imported into.
---
##### `stack`<sup>Required</sup> <a name="stack" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.stack"></a>
```typescript
public readonly stack: Stack;
```
- *Type:* aws-cdk-lib.Stack
The stack in which this resource is defined.
---
##### `arn`<sup>Required</sup> <a name="arn" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.arn"></a>
```typescript
public readonly arn: string;
```
- *Type:* string
---
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.id"></a>
```typescript
public readonly id: string;
```
- *Type:* string
---
##### `name`<sup>Required</sup> <a name="name" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.name"></a>
```typescript
public readonly name: string;
```
- *Type:* string
---
##### `connections`<sup>Optional</sup> <a name="connections" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.connections"></a>
```typescript
public readonly connections: Connections;
```
- *Type:* aws-cdk-lib.aws_ec2.Connections
Manages connections for the cluster.
---
##### `configuration`<sup>Required</sup> <a name="configuration" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerDeploymentBase.property.configuration"></a>
```typescript
public readonly configuration: IActiveMqBrokerConfiguration;
```
- *Type:* <a href="#@cdklabs/cdk-amazonmq.IActiveMqBrokerConfiguration">IActiveMqBrokerConfiguration</a>
---
### ActiveMqBrokerInstance <a name="ActiveMqBrokerInstance" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance"></a>
- *Implements:* <a href="#@cdklabs/cdk-amazonmq.IActiveMqBrokerInstance">IActiveMqBrokerInstance</a>
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 <a name="Initializers" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer"></a>
```typescript
import { ActiveMqBrokerInstance } from '@cdklabs/cdk-amazonmq'
new ActiveMqBrokerInstance(scope: Construct, id: string, props: ActiveMqBrokerInstanceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.props">props</a></code> | <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstanceProps">ActiveMqBrokerInstanceProps</a></code> | *No description.* |
---
##### `scope`<sup>Required</sup> <a name="scope" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.scope"></a>
- *Type:* constructs.Construct
---
##### `id`<sup>Required</sup> <a name="id" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.id"></a>
- *Type:* string
---
##### `props`<sup>Required</sup> <a name="props" id="@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.Initializer.parameter.props"></a>
- *Type:* <a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstanceProps">ActiveMqBrokerInstanceProps</a>
---
#### Methods <a name="Methods" id="Methods"></a>
| **Name** | **Description** |
| --- | --- |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.toString">toString</a></code> | Returns a string representation of this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.with">with</a></code> | Applies one or more mixins to this construct. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.metric">metric</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.metricAmqpMaximumConnections">metricAmqpMaximumConnections</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.metricBurstBalance">metricBurstBalance</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-amazonmq.ActiveMqBrokerInstance.metricConsumerCount">metricConsumerCount</a></code> | *No description.* |
| <code><a href="#@cdklabs/cdk-ama