Class CfnConfiguration
A CloudFormation AWS::AmazonMQ::Configuration
.
Inherited Members
Namespace: Amazon.CDK.AWS.AmazonMQ
Assembly: Amazon.CDK.AWS.AmazonMQ.dll
Syntax (csharp)
public class CfnConfiguration : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnConfiguration
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::AmazonMQ::Configuration
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmazonMQ;
var cfnConfiguration = new CfnConfiguration(this, "MyCfnConfiguration", new CfnConfigurationProps {
Data = "data",
EngineType = "engineType",
EngineVersion = "engineVersion",
Name = "name",
// the properties below are optional
AuthenticationStrategy = "authenticationStrategy",
Description = "description",
Tags = new [] { new TagsEntryProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnConfiguration(Construct, String, ICfnConfigurationProps) | Create a new |
CfnConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the Amazon MQ configuration. |
AttrId | The ID of the Amazon MQ configuration. |
AttrRevision | The revision number of the configuration. |
AuthenticationStrategy | Optional. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Data | The base64-encoded XML configuration. |
Description | The description of the configuration. |
EngineType | The type of broker engine. |
EngineVersion | The version of the broker engine. |
Name | The name of the configuration. |
Tags | Create tags when creating the configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConfiguration(Construct, String, ICfnConfigurationProps)
Create a new AWS::AmazonMQ::Configuration
.
public CfnConfiguration(Construct scope, string id, ICfnConfigurationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnConfigurationProps
- resource properties.
CfnConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the Amazon MQ configuration.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
arn:aws:mq:us-east-2:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
CloudformationAttribute: Arn
AttrId
The ID of the Amazon MQ configuration.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9
CloudformationAttribute: Id
AttrRevision
The revision number of the configuration.
public virtual double AttrRevision { get; }
Property Value
System.Double
Remarks
1
CloudformationAttribute: Revision
AuthenticationStrategy
Optional.
public virtual string AuthenticationStrategy { get; set; }
Property Value
System.String
Remarks
The authentication strategy associated with the configuration. The default is SIMPLE
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Data
The base64-encoded XML configuration.
public virtual string Data { get; set; }
Property Value
System.String
Remarks
Description
The description of the configuration.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EngineType
The type of broker engine.
public virtual string EngineType { get; set; }
Property Value
System.String
Remarks
Note: Currently, Amazon MQ only supports ACTIVEMQ for creating and editing broker configurations.
EngineVersion
The version of the broker engine.
public virtual string EngineVersion { get; set; }
Property Value
System.String
Remarks
Name
The name of the configuration.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags
Create tags when creating the configuration.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>