software.amazon.awscdk.services.amazonmq

Class CfnConfiguration

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.CfnConfiguration

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.009Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConfiguration(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) of the Amazon MQ configuration.
String	getAttrId() The ID of the Amazon MQ configuration.
Number	getAttrRevision() The revision number of the configuration.
String	getAuthenticationStrategy() Optional.
protected Map<String,Object>	getCfnProperties()
String	getData() The base64-encoded XML configuration.
String	getDescription() The description of the configuration.
String	getEngineType() The type of broker engine.
String	getEngineVersion() The version of the broker engine.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthenticationStrategy(String value) Optional.
void	setData(String value) The base64-encoded XML configuration.
void	setDescription(String value) The description of the configuration.
void	setEngineType(String value) The type of broker engine.
void	setEngineVersion(String value) The version of the broker engine.
void	setName(String value) The name of the configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnConfiguration(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public 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

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

The ID of the Amazon MQ configuration.

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

getAttrRevision

@Stability(value=Stable)
 @NotNull
public Number getAttrRevision()

The revision number of the configuration.

1

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Create tags when creating the configuration.

getData

@Stability(value=Stable)
 @NotNull
public String getData()

The base64-encoded XML configuration.

setData

@Stability(value=Stable)
public void setData(@NotNull
                                             String value)

The base64-encoded XML configuration.

getEngineType

@Stability(value=Stable)
 @NotNull
public String getEngineType()

The type of broker engine.

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

setEngineType

@Stability(value=Stable)
public void setEngineType(@NotNull
                                                   String value)

The type of broker engine.

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

getEngineVersion

@Stability(value=Stable)
 @NotNull
public String getEngineVersion()

The version of the broker engine.

For a list of supported engine versions, see

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@NotNull
                                                      String value)

The version of the broker engine.

For a list of supported engine versions, see

getName

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setName(@NotNull
                                             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

@Stability(value=Stable)
 @Nullable
public String getAuthenticationStrategy()

Optional.

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

setAuthenticationStrategy

@Stability(value=Stable)
public void setAuthenticationStrategy(@Nullable
                                                               String value)

Optional.

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the configuration.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the configuration.