Class CfnConfiguration

Creates a new configuration for the specified configuration name.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConfiguration

Implements

IInspectable

IConfigurationRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AmazonMQ

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConfiguration : CfnResource, IInspectable, IConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnConfiguration Inherits CfnResource Implements IInspectable, IConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

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 {
                 EngineType = "engineType",
                 Name = "name",

                 // the properties below are optional
                 AuthenticationStrategy = "authenticationStrategy",
                 Data = "data",
                 Description = "description",
                 EngineVersion = "engineVersion",
                 Tags = new [] { new TagsEntryProperty {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnConfiguration(Construct, string, ICfnConfigurationProps)

Create a new AWS::AmazonMQ::Configuration.

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	Creates a new configuration for the specified configuration name.
ConfigurationRef	A reference to a Configuration resource.
Data	Amazon MQ for Active MQ: The base64-encoded XML configuration.
Description	The description of the configuration.
EngineType	Required.
EngineVersion	The broker engine version.
Name	Required.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Create tags when creating the configuration.

Methods

ArnForConfiguration(IConfigurationRef)	Creates a new configuration for the specified configuration name.
FromConfigurationArn(Construct, string, string)	Creates a new IConfigurationRef from an ARN.
FromConfigurationId(Construct, string, string)	Creates a new IConfigurationRef from a configurationId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnConfiguration(object)	Checks whether the given object is a CfnConfiguration.
RenderProperties(IDictionary<string, object>)	Creates a new configuration for the specified configuration name.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnConfigurationProps

Resource properties.

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

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

string

Remarks

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

CloudformationAttribute: Id

AttrRevision

The revision number of the configuration.

public virtual double AttrRevision { get; }

Property Value

double

Remarks

1

CloudformationAttribute: Revision

AuthenticationStrategy

Optional.

public virtual string? AuthenticationStrategy { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new configuration for the specified configuration name.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

ConfigurationRef

A reference to a Configuration resource.

public virtual IConfigurationReference ConfigurationRef { get; }

Property Value

IConfigurationReference

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Data

Amazon MQ for Active MQ: The base64-encoded XML configuration.

public virtual string? Data { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Description

The description of the configuration.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

EngineType

Required.

public virtual string EngineType { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

EngineVersion

The broker engine version.

public virtual string? EngineVersion { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Name

Required.

public virtual string Name { get; set; }

Property Value

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

TagsRaw

Create tags when creating the configuration.

public virtual CfnConfiguration.ITagsEntryProperty[]? TagsRaw { get; set; }

Property Value

ITagsEntryProperty[]

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Methods

ArnForConfiguration(IConfigurationRef)

Creates a new configuration for the specified configuration name.

public static string ArnForConfiguration(IConfigurationRef resource)

Parameters

resource IConfigurationRef

Returns

string

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

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 {
                 EngineType = "engineType",
                 Name = "name",

                 // the properties below are optional
                 AuthenticationStrategy = "authenticationStrategy",
                 Data = "data",
                 Description = "description",
                 EngineVersion = "engineVersion",
                 Tags = new [] { new TagsEntryProperty {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromConfigurationArn(Construct, string, string)

Creates a new IConfigurationRef from an ARN.

public static IConfigurationRef FromConfigurationArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IConfigurationRef

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

FromConfigurationId(Construct, string, string)

Creates a new IConfigurationRef from a configurationId.

public static IConfigurationRef FromConfigurationId(Construct scope, string id, string configurationId)

Parameters

scope Construct

id string

configurationId string

Returns

IConfigurationRef

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

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.

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

IsCfnConfiguration(object)

Checks whether the given object is a CfnConfiguration.

public static bool IsCfnConfiguration(object x)

Parameters

x object

Returns

bool

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new configuration for the specified configuration name.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Amazon MQ uses the default configuration (the engine type and version).

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

CloudformationResource: AWS::AmazonMQ::Configuration

ExampleMetadata: fixture=_generated

Implements

IInspectable

IConfigurationRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable