Package software.amazon.awscdk.services.amazonmq

Interface CfnConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:25.253Z")
@Stability(Stable)
public interface CfnConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConfiguration.

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.*;
 CfnConfigurationProps cfnConfigurationProps = CfnConfigurationProps.builder()
         .engineType("engineType")
         .name("name")
         // the properties below are optional
         .authenticationStrategy("authenticationStrategy")
         .data("data")
         .description("description")
         .engineVersion("engineVersion")
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfigurationProps.Builder	A builder for CfnConfigurationProps
static final class	CfnConfigurationProps.Jsii$Proxy	An implementation for CfnConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnConfigurationProps.Builder	builder()
default String	getAuthenticationStrategy()	Optional.
default String	getData()	The base64-encoded XML configuration.
default String	getDescription()	The description of the configuration.
String	getEngineType()	The type of broker engine.
default String	getEngineVersion()	The version of the broker engine.
String	getName()	The name of the configuration.
default List<CfnConfiguration.TagsEntryProperty>	getTags()	Create tags when creating the configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngineType

@Stability(Stable)
@NotNull
String getEngineType()

The type of broker engine.

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

See Also:

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

getName

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

See Also:

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

getAuthenticationStrategy

@Stability(Stable)
@Nullable
default String getAuthenticationStrategy()

Optional.

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

See Also:

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

getData

@Stability(Stable)
@Nullable
default String getData()

The base64-encoded XML configuration.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the configuration.

See Also:

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

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The version of the broker engine.

For a list of supported engine versions, see

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnConfiguration.TagsEntryProperty> getTags()

Create tags when creating the configuration.

See Also:

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

builder

@Stability(Stable)
static CfnConfigurationProps.Builder builder()

Returns:

a CfnConfigurationProps.Builder of CfnConfigurationProps