Package software.amazon.awscdk.services.amazonmq

Class CfnConfigurationAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.amazonmq.CfnConfigurationAssociation

All Implemented Interfaces:

IInspectable, IConfigurationAssociationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.227Z")
@Stability(Stable)
public class CfnConfigurationAssociation
extends CfnResource
implements IInspectable, IConfigurationAssociationRef

Use the AWS CloudFormation AWS::AmazonMQ::ConfigurationAssociation resource to associate a configuration with a broker, or return information about the specified ConfigurationAssociation.

Only use one per broker, and don't use a configuration on the broker resource if you have associated a configuration with that broker.

Does not apply to RabbitMQ brokers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amazonmq.*;
 CfnConfigurationAssociation cfnConfigurationAssociation = CfnConfigurationAssociation.Builder.create(this, "MyCfnConfigurationAssociation")
         .broker("broker")
         .configuration(ConfigurationIdProperty.builder()
                 .id("id")
                 .revision(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnConfigurationAssociation.Builder	A fluent builder for CfnConfigurationAssociation.
static interface	CfnConfigurationAssociation.ConfigurationIdProperty	The ConfigurationId property type specifies a configuration Id and the revision of a configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.amazonmq.IConfigurationAssociationRef

IConfigurationAssociationRef.Jsii$Default, IConfigurationAssociationRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnConfigurationAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfigurationAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConfigurationAssociation(software.constructs.Construct scope, String id, CfnConfigurationAssociationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The ID of the ConfigurationAssociation Resource.
String	getBroker()	The broker to associate with a configuration.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	The configuration to associate with a broker.
ConfigurationAssociationReference	getConfigurationAssociationRef()	A reference to a ConfigurationAssociation resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBroker(String value)	The broker to associate with a configuration.
void	setConfiguration(IResolvable value)	The configuration to associate with a broker.
void	setConfiguration(CfnConfigurationAssociation.ConfigurationIdProperty value)	The configuration to associate with a broker.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnConfigurationAssociation

protected CfnConfigurationAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnConfigurationAssociation

protected CfnConfigurationAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConfigurationAssociation

@Stability(Stable)
public CfnConfigurationAssociation(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnConfigurationAssociationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The ID of the ConfigurationAssociation Resource.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigurationAssociationRef

@Stability(Stable)
@NotNull
public ConfigurationAssociationReference getConfigurationAssociationRef()

A reference to a ConfigurationAssociation resource.

Specified by:

getConfigurationAssociationRef in interface IConfigurationAssociationRef

getBroker

@Stability(Stable)
@NotNull
public String getBroker()

The broker to associate with a configuration.

setBroker

@Stability(Stable)
public void setBroker(@NotNull
 String value)

The broker to associate with a configuration.

getConfiguration

@Stability(Stable)
@NotNull
public Object getConfiguration()

The configuration to associate with a broker.

Returns union: either IResolvable or CfnConfigurationAssociation.ConfigurationIdProperty

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 IResolvable value)

The configuration to associate with a broker.

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 CfnConfigurationAssociation.ConfigurationIdProperty value)

The configuration to associate with a broker.