Configuration class

Manages an Amazon MQ configuration. Use this resource to create and manage broker configurations for ActiveMQ and RabbitMQ brokers.

Example Usage

ActiveMQ

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.mq.Configuration("example", {
    description: "Example Configuration",
    name: "example",
    engineType: "ActiveMQ",
    engineVersion: "5.19",
    data: `<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>
<broker xmlns=\\"http://activemq.apache.org/schema/core\\">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag=\\"true\\"/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling=\\"86400000\\" zeroExpirationOverride=\\"86400000\\"/>
  </plugins>
</broker>
`,
});
import pulumi
import pulumi_aws as aws

example = aws.mq.Configuration("example",
    description="Example Configuration",
    name="example",
    engine_type="ActiveMQ",
    engine_version="5.19",
    data="""<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<broker xmlns=\"http://activemq.apache.org/schema/core\">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag=\"true\"/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling=\"86400000\" zeroExpirationOverride=\"86400000\"/>
  </plugins>
</broker>
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Mq.Configuration("example", new()
    {
        Description = "Example Configuration",
        Name = "example",
        EngineType = "ActiveMQ",
        EngineVersion = "5.19",
        Data = @"<?xml version=\""1.0\"" encoding=\""UTF-8\"" standalone=\""yes\""?>
<broker xmlns=\""http://activemq.apache.org/schema/core\"">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag=\""true\""/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling=\""86400000\"" zeroExpirationOverride=\""86400000\""/>
  </plugins>
</broker>
",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/mq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mq.NewConfiguration(ctx, "example", &mq.ConfigurationArgs{
			Description:   pulumi.String("Example Configuration"),
			Name:          pulumi.String("example"),
			EngineType:    pulumi.String("ActiveMQ"),
			EngineVersion: pulumi.String("5.19"),
			Data: pulumi.String(`<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<broker xmlns=\"http://activemq.apache.org/schema/core\">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag=\"true\"/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling=\"86400000\" zeroExpirationOverride=\"86400000\"/>
  </plugins>
</broker>
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_mq_configuration" "example" {
  description    = "Example Configuration"
  name           = "example"
  engine_type    = "ActiveMQ"
  engine_version = "5.19"
  data           = "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\n<broker xmlns=\\\"http://activemq.apache.org/schema/core\\\">\n  <plugins>\n    <forcePersistencyModeBrokerPlugin persistenceFlag=\\\"true\\\"/>\n    <statisticsBrokerPlugin/>\n    <timeStampingBrokerPlugin ttlCeiling=\\\"86400000\\\" zeroExpirationOverride=\\\"86400000\\\"/>\n  </plugins>\n</broker>\n"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.Configuration;
import com.pulumi.aws.mq.ConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Configuration("example", ConfigurationArgs.builder()
            .description("Example Configuration")
            .name("example")
            .engineType("ActiveMQ")
            .engineVersion("5.19")
            .data("""
<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<broker xmlns=\"http://activemq.apache.org/schema/core\">
  <plugins>
    <forcePersistencyModeBrokerPlugin persistenceFlag=\"true\"/>
    <statisticsBrokerPlugin/>
    <timeStampingBrokerPlugin ttlCeiling=\"86400000\" zeroExpirationOverride=\"86400000\"/>
  </plugins>
</broker>
            """)
            .build());

    }
}
resources:
  example:
    type: aws:mq:Configuration
    properties:
      description: Example Configuration
      name: example
      engineType: ActiveMQ
      engineVersion: '5.19'
      data: |
        <?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
        <broker xmlns=\"http://activemq.apache.org/schema/core\">
          <plugins>
            <forcePersistencyModeBrokerPlugin persistenceFlag=\"true\"/>
            <statisticsBrokerPlugin/>
            <timeStampingBrokerPlugin ttlCeiling=\"86400000\" zeroExpirationOverride=\"86400000\"/>
          </plugins>
        </broker>

RabbitMQ

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.mq.Configuration("example", {
    description: "Example Configuration",
    name: "example",
    engineType: "RabbitMQ",
    engineVersion: "4.2",
    data: `# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds
consumer_timeout = 1800000
`,
});
import pulumi
import pulumi_aws as aws

example = aws.mq.Configuration("example",
    description="Example Configuration",
    name="example",
    engine_type="RabbitMQ",
    engine_version="4.2",
    data="""# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds
consumer_timeout = 1800000
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Mq.Configuration("example", new()
    {
        Description = "Example Configuration",
        Name = "example",
        EngineType = "RabbitMQ",
        EngineVersion = "4.2",
        Data = @"# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds
consumer_timeout = 1800000
",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/mq"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mq.NewConfiguration(ctx, "example", &mq.ConfigurationArgs{
			Description:   pulumi.String("Example Configuration"),
			Name:          pulumi.String("example"),
			EngineType:    pulumi.String("RabbitMQ"),
			EngineVersion: pulumi.String("4.2"),
			Data:          pulumi.String("# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds\nconsumer_timeout = 1800000\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_mq_configuration" "example" {
  description    = "Example Configuration"
  name           = "example"
  engine_type    = "RabbitMQ"
  engine_version = "4.2"
  data           = "# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds\nconsumer_timeout = 1800000\n"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mq.Configuration;
import com.pulumi.aws.mq.ConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Configuration("example", ConfigurationArgs.builder()
            .description("Example Configuration")
            .name("example")
            .engineType("RabbitMQ")
            .engineVersion("4.2")
            .data("""
# Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds
consumer_timeout = 1800000
            """)
            .build());

    }
}
resources:
  example:
    type: aws:mq:Configuration
    properties:
      description: Example Configuration
      name: example
      engineType: RabbitMQ
      engineVersion: '4.2'
      data: |
        # Default RabbitMQ delivery acknowledgement timeout is 30 minutes in milliseconds
        consumer_timeout = 1800000

Import

Using pulumi import, import MQ Configurations using the configuration ID. For example:

$ pulumi import aws:mq/configuration:Configuration example c-0187d1eb-88c8-475a-9b79-16ef5a10c94f

Constructors

Configuration(String name, {ConfigurationArgs? args, CustomResourceOptions? options})
Creates a new Configuration. name The Pulumi resource name. args Arguments used to configure this Configuration. The set of arguments for Configuration. options Resource options controlling this resource's behavior.
Configuration.reference(String urn)
Creates a typed reference to an existing Configuration resource.

Properties

arn ↔ Output<String>
ARN of the configuration.
latefinal
authenticationStrategy ↔ Output<String>
Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for RabbitMQ engine type.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
data ↔ Output<String>
Broker configuration in XML format for ActiveMQ or Cuttlefish format for RabbitMQ. See AWS documentation for supported parameters and format of the XML.
latefinal
description ↔ Output<String?>
Description of the configuration.
latefinal
engineType ↔ Output<String>
Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
latefinal
engineVersion ↔ Output<String>
Version of the broker engine.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
latestRevision ↔ Output<int>
Latest revision of the configuration.
latefinal
name ↔ Output<String>
Name of the configuration.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipDestroy ↔ Output<bool?>
Set to true if you do not wish the configuration to be deleted at destroy time, and instead just remove the configuration from the Terraform state. Default is false.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ConfigurationState? state, CustomResourceOptions? options}) → Configuration
Gets an existing Configuration resource's state with the given name and id.