Package software.amazon.awscdk.services.amazonmq

Class CfnConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.325Z") @Stability(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();

  • 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

    • CfnConfiguration

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

    • CfnConfiguration

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

    • CfnConfiguration

      @Stability(Stable) public CfnConfiguration(@NotNull 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 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.

    • getAttrArn

      @Stability(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(Stable) @NotNull public String getAttrId()
      The ID of the Amazon MQ configuration.

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

    • getAttrRevision

      @Stability(Stable) @NotNull public Number getAttrRevision()
      The revision number of the configuration.

      1

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Create tags when creating the configuration.

    • getData

      @Stability(Stable) @NotNull public String getData()
      The base64-encoded XML configuration.

    • setData

      @Stability(Stable) public void setData(@NotNull String value)
      The base64-encoded XML configuration.

    • getEngineType

      @Stability(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(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(Stable) @NotNull public String getEngineVersion()
      The version of the broker engine.

      For a list of supported engine versions, see

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@NotNull String value)
      The version of the broker engine.

      For a list of supported engine versions, see

    • getName

      @Stability(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(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(Stable) @Nullable public String getAuthenticationStrategy()
      Optional.

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

    • setAuthenticationStrategy

      @Stability(Stable) public void setAuthenticationStrategy(@Nullable String value)
      Optional.

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

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the configuration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the configuration.