← All packages

AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

Configuration

Provides an MQ Configuration Resource.

For more information on Amazon MQ, see Amazon MQ documentation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Mq.Configuration("example", new Aws.Mq.ConfigurationArgs
        {
            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>

",
            Description = "Example Configuration",
            EngineType = "ActiveMQ",
            EngineVersion = "5.15.0",
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Data:          pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v", "<?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", "\n")),
			Description:   pulumi.String("Example Configuration"),
			EngineType:    pulumi.String("ActiveMQ"),
			EngineVersion: pulumi.String("5.15.0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .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>

            """)
            .description("Example Configuration")
            .engineType("ActiveMQ")
            .engineVersion("5.15.0")
            .build());

        }
}

import pulumi
import pulumi_aws as aws

example = aws.mq.Configuration("example",
    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>

""",
    description="Example Configuration",
    engine_type="ActiveMQ",
    engine_version="5.15.0")

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

const example = new aws.mq.Configuration("example", {
    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>
`,
    description: "Example Configuration",
    engineType: "ActiveMQ",
    engineVersion: "5.15.0",
});

resources:
  example:
    type: aws:mq:Configuration
    properties:
      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>        

      description: Example Configuration
      engineType: ActiveMQ
      engineVersion: 5.15.0

Create a Configuration Resource

new Configuration(name: string, args: ConfigurationArgs, opts?: CustomResourceOptions);

@overload
def Configuration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  authentication_strategy: Optional[str] = None,
                  data: Optional[str] = None,
                  description: Optional[str] = None,
                  engine_type: Optional[str] = None,
                  engine_version: Optional[str] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
@overload
def Configuration(resource_name: str,
                  args: ConfigurationArgs,
                  opts: Optional[ResourceOptions] = None)

func NewConfiguration(ctx *Context, name string, args ConfigurationArgs, opts ...ResourceOption) (*Configuration, error)

public Configuration(string name, ConfigurationArgs args, CustomResourceOptions? opts = null)

public Configuration(String name, ConfigurationArgs args)
public Configuration(String name, ConfigurationArgs args, CustomResourceOptions options)

type: aws:mq:Configuration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Configuration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Configuration resource accepts the following input properties:

Data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
EngineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
EngineVersion string: Version of the broker engine.
AuthenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
Description string: Description of the configuration.
Name string: Name of the configuration.
Tags Dictionary<string, string>: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
EngineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
EngineVersion string: Version of the broker engine.
AuthenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
Description string: Description of the configuration.
Name string: Name of the configuration.
Tags map[string]string: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

data String: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
engineType String: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion String: Version of the broker engine.
authenticationStrategy String: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
description String: Description of the configuration.
name String: Name of the configuration.
tags Map: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
engineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion string: Version of the broker engine.
authenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
description string: Description of the configuration.
name string: Name of the configuration.
tags {[key: string]: string}: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

data str: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
engine_type str: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engine_version str: Version of the broker engine.
authentication_strategy str: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
description str: Description of the configuration.
name str: Name of the configuration.
tags Mapping[str, str]: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

data String: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
engineType String: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion String: Version of the broker engine.
authenticationStrategy String: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
description String: Description of the configuration.
name String: Name of the configuration.
tags Map: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Configuration resource produces the following output properties:

Arn string: ARN of the configuration.
Id string: The provider-assigned unique ID for this managed resource.
LatestRevision int: Latest revision of the configuration.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider .

Arn string: ARN of the configuration.
Id string: The provider-assigned unique ID for this managed resource.
LatestRevision int: Latest revision of the configuration.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider .

arn String: ARN of the configuration.
id String: The provider-assigned unique ID for this managed resource.
latestRevision Integer: Latest revision of the configuration.
tagsAll Map: A map of tags assigned to the resource, including those inherited from the provider .

arn string: ARN of the configuration.
id string: The provider-assigned unique ID for this managed resource.
latestRevision number: Latest revision of the configuration.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider .

arn str: ARN of the configuration.
id str: The provider-assigned unique ID for this managed resource.
latest_revision int: Latest revision of the configuration.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider .

arn String: ARN of the configuration.
id String: The provider-assigned unique ID for this managed resource.
latestRevision Number: Latest revision of the configuration.
tagsAll Map: A map of tags assigned to the resource, including those inherited from the provider .

Look up an Existing Configuration Resource

Get an existing Configuration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConfigurationState, opts?: CustomResourceOptions): Configuration

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        authentication_strategy: Optional[str] = None,
        data: Optional[str] = None,
        description: Optional[str] = None,
        engine_type: Optional[str] = None,
        engine_version: Optional[str] = None,
        latest_revision: Optional[int] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Configuration

func GetConfiguration(ctx *Context, name string, id IDInput, state *ConfigurationState, opts ...ResourceOption) (*Configuration, error)

public static Configuration Get(string name, Input<string> id, ConfigurationState? state, CustomResourceOptions? opts = null)

public static Configuration get(String name, Output<String> id, ConfigurationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: ARN of the configuration.
AuthenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
Data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
Description string: Description of the configuration.
EngineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
EngineVersion string: Version of the broker engine.
LatestRevision int: Latest revision of the configuration.
Name string: Name of the configuration.
Tags Dictionary<string, string>: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider .

Arn string: ARN of the configuration.
AuthenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
Data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
Description string: Description of the configuration.
EngineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
EngineVersion string: Version of the broker engine.
LatestRevision int: Latest revision of the configuration.
Name string: Name of the configuration.
Tags map[string]string: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider .

arn String: ARN of the configuration.
authenticationStrategy String: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
data String: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
description String: Description of the configuration.
engineType String: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion String: Version of the broker engine.
latestRevision Integer: Latest revision of the configuration.
name String: Name of the configuration.
tags Map: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map: A map of tags assigned to the resource, including those inherited from the provider .

arn string: ARN of the configuration.
authenticationStrategy string: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
data string: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
description string: Description of the configuration.
engineType string: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion string: Version of the broker engine.
latestRevision number: Latest revision of the configuration.
name string: Name of the configuration.
tags {[key: string]: string}: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider .

arn str: ARN of the configuration.
authentication_strategy str: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
data str: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
description str: Description of the configuration.
engine_type str: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engine_version str: Version of the broker engine.
latest_revision int: Latest revision of the configuration.
name str: Name of the configuration.
tags Mapping[str, str]: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider .

arn String: ARN of the configuration.
authenticationStrategy String: Authentication strategy associated with the configuration. Valid values are simple and ldap. ldap is not supported for engine_type RabbitMQ.
data String: Broker configuration in XML format. See official docs for supported parameters and format of the XML.
description String: Description of the configuration.
engineType String: Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
engineVersion String: Version of the broker engine.
latestRevision Number: Latest revision of the configuration.
name String: Name of the configuration.
tags Map: Map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map: A map of tags assigned to the resource, including those inherited from the provider .

Import

MQ Configurations can be imported using the configuration ID, e.g.,

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

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.