This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-amazonmq

AWS AmazonMQ Construct Library

const amazonmq = require('@aws-cdk/aws-amazonmq');

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.AmazonMQ" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.AmazonMQ --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.AmazonMQ" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:amazonmq:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="amazonmq" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>amazonmq</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:amazonmq:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='amazonmq', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-amazonmq@0.25.3

package.json:

{
  "@aws-cdk/aws-amazonmq": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-amazonmq@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-amazonmq@0.25.3

package.json:

{
  "@aws-cdk/aws-amazonmq": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-amazonmq@0.25.3

CfnBroker

class @aws-cdk/aws-amazonmq.CfnBroker(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker;
const { CfnBroker } = require('@aws-cdk/aws-amazonmq');
import { CfnBroker } from '@aws-cdk/aws-amazonmq';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
brokerAmqpEndpoints
Type:string[] (readonly)
brokerArn
Type:string (readonly)
brokerConfigurationId
Type:string (readonly)
brokerConfigurationRevision
Type:@aws-cdk/cdk.Token (readonly)
brokerId
Type:string (readonly)
brokerIpAddresses
Type:string[] (readonly)
brokerMqttEndpoints
Type:string[] (readonly)
brokerOpenWireEndpoints
Type:string[] (readonly)
brokerStompEndpoints
Type:string[] (readonly)
brokerWssEndpoints
Type:string[] (readonly)
propertyOverrides
Type:CfnBrokerProps (readonly)
class ConfigurationIdProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker.ConfigurationIdProperty;
// CfnBroker.ConfigurationIdProperty is an interface
import { CfnBroker.ConfigurationIdProperty } from '@aws-cdk/aws-amazonmq';
id

CfnBroker.ConfigurationIdProperty.Id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-id

Type:string
revision

CfnBroker.ConfigurationIdProperty.Revision

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-configurationid.html#cfn-amazonmq-broker-configurationid-revision

Type:number or @aws-cdk/cdk.Token
class LogListProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker.LogListProperty;
// CfnBroker.LogListProperty is an interface
import { CfnBroker.LogListProperty } from '@aws-cdk/aws-amazonmq';
audit

CfnBroker.LogListProperty.Audit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-audit

Type:boolean or @aws-cdk/cdk.Token (optional)
general

CfnBroker.LogListProperty.General

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-loglist.html#cfn-amazonmq-broker-loglist-general

Type:boolean or @aws-cdk/cdk.Token (optional)
class MaintenanceWindowProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker.MaintenanceWindowProperty;
// CfnBroker.MaintenanceWindowProperty is an interface
import { CfnBroker.MaintenanceWindowProperty } from '@aws-cdk/aws-amazonmq';
dayOfWeek

CfnBroker.MaintenanceWindowProperty.DayOfWeek

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-dayofweek

Type:string
timeOfDay

CfnBroker.MaintenanceWindowProperty.TimeOfDay

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timeofday

Type:string
timeZone

CfnBroker.MaintenanceWindowProperty.TimeZone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-maintenancewindow.html#cfn-amazonmq-broker-maintenancewindow-timezone

Type:string
class TagsEntryProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker.TagsEntryProperty;
// CfnBroker.TagsEntryProperty is an interface
import { CfnBroker.TagsEntryProperty } from '@aws-cdk/aws-amazonmq';
key

CfnBroker.TagsEntryProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-key

Type:string
value

CfnBroker.TagsEntryProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-tagsentry.html#cfn-amazonmq-broker-tagsentry-value

Type:string
class UserProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBroker.UserProperty;
// CfnBroker.UserProperty is an interface
import { CfnBroker.UserProperty } from '@aws-cdk/aws-amazonmq';
password

CfnBroker.UserProperty.Password

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-password

Type:string
username

CfnBroker.UserProperty.Username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-username

Type:string
consoleAccess

CfnBroker.UserProperty.ConsoleAccess

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-consoleaccess

Type:boolean or @aws-cdk/cdk.Token (optional)
groups

CfnBroker.UserProperty.Groups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-groups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnBrokerProps (interface)

class @aws-cdk/aws-amazonmq.CfnBrokerProps

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnBrokerProps;
// CfnBrokerProps is an interface
import { CfnBrokerProps } from '@aws-cdk/aws-amazonmq';
autoMinorVersionUpgrade

AWS::AmazonMQ::Broker.AutoMinorVersionUpgrade

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-autominorversionupgrade

Type:boolean or @aws-cdk/cdk.Token
brokerName

AWS::AmazonMQ::Broker.BrokerName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-brokername

Type:string
deploymentMode

AWS::AmazonMQ::Broker.DeploymentMode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-deploymentmode

Type:string
engineType

AWS::AmazonMQ::Broker.EngineType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-enginetype

Type:string
engineVersion

AWS::AmazonMQ::Broker.EngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-engineversion

Type:string
hostInstanceType

AWS::AmazonMQ::Broker.HostInstanceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-hostinstancetype

Type:string
publiclyAccessible

AWS::AmazonMQ::Broker.PubliclyAccessible

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-publiclyaccessible

Type:boolean or @aws-cdk/cdk.Token
users

AWS::AmazonMQ::Broker.Users

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-users

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or UserProperty)[]
configuration

AWS::AmazonMQ::Broker.Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-configuration

Type:@aws-cdk/cdk.Token or ConfigurationIdProperty (optional)
logs

AWS::AmazonMQ::Broker.Logs

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-logs

Type:@aws-cdk/cdk.Token or LogListProperty (optional)
maintenanceWindowStartTime

AWS::AmazonMQ::Broker.MaintenanceWindowStartTime

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-maintenancewindowstarttime

Type:@aws-cdk/cdk.Token or MaintenanceWindowProperty (optional)
securityGroups

AWS::AmazonMQ::Broker.SecurityGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-securitygroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
subnetIds

AWS::AmazonMQ::Broker.SubnetIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-subnetids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
tags

AWS::AmazonMQ::Broker.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html#cfn-amazonmq-broker-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagsEntryProperty)[] (optional)

CfnConfiguration

class @aws-cdk/aws-amazonmq.CfnConfiguration(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfiguration;
const { CfnConfiguration } = require('@aws-cdk/aws-amazonmq');
import { CfnConfiguration } from '@aws-cdk/aws-amazonmq';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
configurationArn
Type:string (readonly)
configurationId
Type:string (readonly)
configurationRevision
Type:@aws-cdk/cdk.Token (readonly)
propertyOverrides
Type:CfnConfigurationProps (readonly)
class TagsEntryProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfiguration.TagsEntryProperty;
// CfnConfiguration.TagsEntryProperty is an interface
import { CfnConfiguration.TagsEntryProperty } from '@aws-cdk/aws-amazonmq';
key

CfnConfiguration.TagsEntryProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-key

Type:string
value

CfnConfiguration.TagsEntryProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configuration-tagsentry.html#cfn-amazonmq-configuration-tagsentry-value

Type:string
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnConfigurationAssociation

class @aws-cdk/aws-amazonmq.CfnConfigurationAssociation(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfigurationAssociation;
const { CfnConfigurationAssociation } = require('@aws-cdk/aws-amazonmq');
import { CfnConfigurationAssociation } from '@aws-cdk/aws-amazonmq';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
configurationAssociationId
Type:string (readonly)
propertyOverrides
Type:CfnConfigurationAssociationProps (readonly)
class ConfigurationIdProperty

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfigurationAssociation.ConfigurationIdProperty;
// CfnConfigurationAssociation.ConfigurationIdProperty is an interface
import { CfnConfigurationAssociation.ConfigurationIdProperty } from '@aws-cdk/aws-amazonmq';
id

CfnConfigurationAssociation.ConfigurationIdProperty.Id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-id

Type:string
revision

CfnConfigurationAssociation.ConfigurationIdProperty.Revision

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-configurationassociation-configurationid.html#cfn-amazonmq-configurationassociation-configurationid-revision

Type:number or @aws-cdk/cdk.Token
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnConfigurationAssociationProps (interface)

class @aws-cdk/aws-amazonmq.CfnConfigurationAssociationProps

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfigurationAssociationProps;
// CfnConfigurationAssociationProps is an interface
import { CfnConfigurationAssociationProps } from '@aws-cdk/aws-amazonmq';
broker

AWS::AmazonMQ::ConfigurationAssociation.Broker

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-broker

Type:string
configuration

AWS::AmazonMQ::ConfigurationAssociation.Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html#cfn-amazonmq-configurationassociation-configuration

Type:@aws-cdk/cdk.Token or ConfigurationIdProperty

CfnConfigurationProps (interface)

class @aws-cdk/aws-amazonmq.CfnConfigurationProps

Language-specific names:

using Amazon.CDK.AWS.AmazonMQ;
import software.amazon.awscdk.services.amazonmq.CfnConfigurationProps;
// CfnConfigurationProps is an interface
import { CfnConfigurationProps } from '@aws-cdk/aws-amazonmq';
data

AWS::AmazonMQ::Configuration.Data

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-data

Type:string
engineType

AWS::AmazonMQ::Configuration.EngineType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-enginetype

Type:string
engineVersion

AWS::AmazonMQ::Configuration.EngineVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-engineversion

Type:string
name

AWS::AmazonMQ::Configuration.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-name

Type:string
description

AWS::AmazonMQ::Configuration.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-description

Type:string (optional)
tags

AWS::AmazonMQ::Configuration.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html#cfn-amazonmq-configuration-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TagsEntryProperty)[] (optional)