software.amazon.awscdk.services.amazonmq

Class CfnConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.amazonmq.CfnConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.213Z")
public class CfnConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AmazonMQ::Configuration`.

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

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.*;
 CfnConfiguration cfnConfiguration = CfnConfiguration.Builder.create(this, "MyCfnConfiguration")
         .data("data")
         .engineType("engineType")
         .engineVersion("engineVersion")
         .name("name")
         // the properties below are optional
         .authenticationStrategy("authenticationStrategy")
         .description("description")
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConfiguration.Builder A fluent builder for CfnConfiguration.
static interface	CfnConfiguration.TagsEntryProperty A key-value pair to associate with the configuration.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfiguration(Construct scope, java.lang.String id, CfnConfigurationProps props) Create a new `AWS::AmazonMQ::Configuration`.
protected	CfnConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the Amazon MQ configuration.
java.lang.String	getAttrId() The ID of the Amazon MQ configuration.
java.lang.Number	getAttrRevision() The revision number of the configuration.
java.lang.String	getAuthenticationStrategy() Optional.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getData() The base64-encoded XML configuration.
java.lang.String	getDescription() The description of the configuration.
java.lang.String	getEngineType() The type of broker engine.
java.lang.String	getEngineVersion() The version of the broker engine.
java.lang.String	getName() The name of the configuration.
TagManager	getTags() Create tags when creating the configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthenticationStrategy(java.lang.String value) Optional.
void	setData(java.lang.String value) The base64-encoded XML configuration.
void	setDescription(java.lang.String value) The description of the configuration.
void	setEngineType(java.lang.String value) The type of broker engine.
void	setEngineVersion(java.lang.String value) The version of the broker engine.
void	setName(java.lang.String value) The name of the configuration.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConfiguration

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

CfnConfiguration

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

CfnConfiguration

public CfnConfiguration(Construct scope,
                        java.lang.String id,
                        CfnConfigurationProps props)

Create a new `AWS::AmazonMQ::Configuration`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the Amazon MQ configuration.

arn:aws:mq:us-east-2:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

getAttrId

public java.lang.String getAttrId()

The ID of the Amazon MQ configuration.

c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9

getAttrRevision

public java.lang.Number getAttrRevision()

The revision number of the configuration.

1

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Create tags when creating the configuration.

getData

public java.lang.String getData()

The base64-encoded XML configuration.

setData

public void setData(java.lang.String value)

The base64-encoded XML configuration.

getEngineType

public java.lang.String getEngineType()

The type of broker engine.

Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.

setEngineType

public void setEngineType(java.lang.String value)

The type of broker engine.

Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.

getEngineVersion

public java.lang.String getEngineVersion()

The version of the broker engine.

For a list of supported engine versions, see

setEngineVersion

public void setEngineVersion(java.lang.String value)

The version of the broker engine.

For a list of supported engine versions, see

getName

public java.lang.String getName()

The name of the configuration.

This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

setName

public void setName(java.lang.String value)

The name of the configuration.

This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

getAuthenticationStrategy

public java.lang.String getAuthenticationStrategy()

Optional.

The authentication strategy associated with the configuration. The default is SIMPLE .

setAuthenticationStrategy

public void setAuthenticationStrategy(java.lang.String value)

Optional.

The authentication strategy associated with the configuration. The default is SIMPLE .

getDescription

public java.lang.String getDescription()

The description of the configuration.

setDescription

public void setDescription(java.lang.String value)

The description of the configuration.