mq

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Broker

type Broker struct {
	// contains filtered or unexported fields
}

Provides an MQ Broker Resource. This resources also manages users for the broker.

For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html).

Changes to an MQ Broker can occur when you change a parameter, such as `configuration` or `user`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `apply_immediately` flag to instruct the service to apply the change immediately (see documentation below).

> **Note:** using `apply_immediately` can result in a brief downtime as the broker reboots.

> **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html).

func GetBroker

func GetBroker(ctx *pulumi.Context,
	name string, id pulumi.ID, state *BrokerState, opts ...pulumi.ResourceOpt) (*Broker, error)

GetBroker gets an existing Broker resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBroker

func NewBroker(ctx *pulumi.Context,
	name string, args *BrokerArgs, opts ...pulumi.ResourceOpt) (*Broker, error)

NewBroker registers a new resource with the given unique name, arguments, and options.

func (*Broker) ApplyImmediately

func (r *Broker) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is `false`.

func (*Broker) Arn

func (r *Broker) Arn() *pulumi.StringOutput

The ARN of the broker.

func (*Broker) AutoMinorVersionUpgrade

func (r *Broker) AutoMinorVersionUpgrade() *pulumi.BoolOutput

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.

func (*Broker) BrokerName

func (r *Broker) BrokerName() *pulumi.StringOutput

The name of the broker.

func (*Broker) Configuration

func (r *Broker) Configuration() *pulumi.Output

Configuration of the broker. See below.

func (*Broker) DeploymentMode

func (r *Broker) DeploymentMode() *pulumi.StringOutput

The deployment mode of the broker. Supported: `SINGLE_INSTANCE` and `ACTIVE_STANDBY_MULTI_AZ`. Defaults to `SINGLE_INSTANCE`.

func (*Broker) EngineType

func (r *Broker) EngineType() *pulumi.StringOutput

The type of broker engine. Currently, Amazon MQ supports only `ActiveMQ`.

func (*Broker) EngineVersion

func (r *Broker) EngineVersion() *pulumi.StringOutput

The version of the broker engine. Currently, Amazon MQ supports only `5.15.0` or `5.15.6`.

func (*Broker) HostInstanceType

func (r *Broker) HostInstanceType() *pulumi.StringOutput

The broker's instance type. e.g. `mq.t2.micro` or `mq.m4.large`

func (*Broker) ID

func (r *Broker) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Broker) Instances

func (r *Broker) Instances() *pulumi.ArrayOutput

A list of information about allocated brokers (both active & standby). * `instances.0.console_url` - The URL of the broker's [ActiveMQ Web Console](http://activemq.apache.org/web-console.html). * `instances.0.ip_address` - The IP Address of the broker. * `instances.0.endpoints` - The broker's wire-level protocol endpoints in the following order & format referenceable e.g. as `instances.0.endpoints.0` (SSL): * `ssl://broker-id.mq.us-west-2.amazonaws.com:61617` * `amqp+ssl://broker-id.mq.us-west-2.amazonaws.com:5671` * `stomp+ssl://broker-id.mq.us-west-2.amazonaws.com:61614` * `mqtt+ssl://broker-id.mq.us-west-2.amazonaws.com:8883` * `wss://broker-id.mq.us-west-2.amazonaws.com:61619`

func (*Broker) Logs added in v0.16.3

func (r *Broker) Logs() *pulumi.Output

Logging configuration of the broker. See below.

func (*Broker) MaintenanceWindowStartTime

func (r *Broker) MaintenanceWindowStartTime() *pulumi.Output

Maintenance window start time. See below.

func (*Broker) PubliclyAccessible

func (r *Broker) PubliclyAccessible() *pulumi.BoolOutput

Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.

func (*Broker) SecurityGroups

func (r *Broker) SecurityGroups() *pulumi.ArrayOutput

The list of security group IDs assigned to the broker.

func (*Broker) SubnetIds

func (r *Broker) SubnetIds() *pulumi.ArrayOutput

The list of subnet IDs in which to launch the broker. A `SINGLE_INSTANCE` deployment requires one subnet. An `ACTIVE_STANDBY_MULTI_AZ` deployment requires two subnets.

func (*Broker) Tags added in v0.16.8

func (r *Broker) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Broker) URN

func (r *Broker) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Broker) Users

func (r *Broker) Users() *pulumi.ArrayOutput

The list of all ActiveMQ usernames for the specified broker. See below.

type BrokerArgs

type BrokerArgs struct {
	// Specifies whether any broker modifications
	// are applied immediately, or during the next maintenance window. Default is `false`.
	ApplyImmediately interface{}
	// Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.
	AutoMinorVersionUpgrade interface{}
	// The name of the broker.
	BrokerName interface{}
	// Configuration of the broker. See below.
	Configuration interface{}
	// The deployment mode of the broker. Supported: `SINGLE_INSTANCE` and `ACTIVE_STANDBY_MULTI_AZ`. Defaults to `SINGLE_INSTANCE`.
	DeploymentMode interface{}
	// The type of broker engine. Currently, Amazon MQ supports only `ActiveMQ`.
	EngineType interface{}
	// The version of the broker engine. Currently, Amazon MQ supports only `5.15.0` or `5.15.6`.
	EngineVersion interface{}
	// The broker's instance type. e.g. `mq.t2.micro` or `mq.m4.large`
	HostInstanceType interface{}
	// Logging configuration of the broker. See below.
	Logs interface{}
	// Maintenance window start time. See below.
	MaintenanceWindowStartTime interface{}
	// Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
	PubliclyAccessible interface{}
	// The list of security group IDs assigned to the broker.
	SecurityGroups interface{}
	// The list of subnet IDs in which to launch the broker. A `SINGLE_INSTANCE` deployment requires one subnet. An `ACTIVE_STANDBY_MULTI_AZ` deployment requires two subnets.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// The list of all ActiveMQ usernames for the specified broker. See below.
	Users interface{}
}

The set of arguments for constructing a Broker resource.

type BrokerState

type BrokerState struct {
	// Specifies whether any broker modifications
	// are applied immediately, or during the next maintenance window. Default is `false`.
	ApplyImmediately interface{}
	// The ARN of the broker.
	Arn interface{}
	// Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.
	AutoMinorVersionUpgrade interface{}
	// The name of the broker.
	BrokerName interface{}
	// Configuration of the broker. See below.
	Configuration interface{}
	// The deployment mode of the broker. Supported: `SINGLE_INSTANCE` and `ACTIVE_STANDBY_MULTI_AZ`. Defaults to `SINGLE_INSTANCE`.
	DeploymentMode interface{}
	// The type of broker engine. Currently, Amazon MQ supports only `ActiveMQ`.
	EngineType interface{}
	// The version of the broker engine. Currently, Amazon MQ supports only `5.15.0` or `5.15.6`.
	EngineVersion interface{}
	// The broker's instance type. e.g. `mq.t2.micro` or `mq.m4.large`
	HostInstanceType interface{}
	// A list of information about allocated brokers (both active & standby).
	// * `instances.0.console_url` - The URL of the broker's [ActiveMQ Web Console](http://activemq.apache.org/web-console.html).
	// * `instances.0.ip_address` - The IP Address of the broker.
	// * `instances.0.endpoints` - The broker's wire-level protocol endpoints in the following order & format referenceable e.g. as `instances.0.endpoints.0` (SSL):
	// * `ssl://broker-id.mq.us-west-2.amazonaws.com:61617`
	// * `amqp+ssl://broker-id.mq.us-west-2.amazonaws.com:5671`
	// * `stomp+ssl://broker-id.mq.us-west-2.amazonaws.com:61614`
	// * `mqtt+ssl://broker-id.mq.us-west-2.amazonaws.com:8883`
	// * `wss://broker-id.mq.us-west-2.amazonaws.com:61619`
	Instances interface{}
	// Logging configuration of the broker. See below.
	Logs interface{}
	// Maintenance window start time. See below.
	MaintenanceWindowStartTime interface{}
	// Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
	PubliclyAccessible interface{}
	// The list of security group IDs assigned to the broker.
	SecurityGroups interface{}
	// The list of subnet IDs in which to launch the broker. A `SINGLE_INSTANCE` deployment requires one subnet. An `ACTIVE_STANDBY_MULTI_AZ` deployment requires two subnets.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// The list of all ActiveMQ usernames for the specified broker. See below.
	Users interface{}
}

Input properties used for looking up and filtering Broker resources.

type Configuration

type Configuration struct {
	// contains filtered or unexported fields
}

Provides an MQ Configuration Resource.

For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html).

func GetConfiguration

func GetConfiguration(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ConfigurationState, opts ...pulumi.ResourceOpt) (*Configuration, error)

GetConfiguration gets an existing Configuration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConfiguration

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

NewConfiguration registers a new resource with the given unique name, arguments, and options.

func (*Configuration) Arn

func (r *Configuration) Arn() *pulumi.StringOutput

The ARN of the configuration.

func (*Configuration) Data

func (r *Configuration) Data() *pulumi.StringOutput

The broker configuration in XML format. See [official docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html) for supported parameters and format of the XML.

func (*Configuration) Description

func (r *Configuration) Description() *pulumi.StringOutput

The description of the configuration.

func (*Configuration) EngineType

func (r *Configuration) EngineType() *pulumi.StringOutput

The type of broker engine.

func (*Configuration) EngineVersion

func (r *Configuration) EngineVersion() *pulumi.StringOutput

The version of the broker engine.

func (*Configuration) ID

func (r *Configuration) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Configuration) LatestRevision

func (r *Configuration) LatestRevision() *pulumi.IntOutput

The latest revision of the configuration.

func (*Configuration) Name

func (r *Configuration) Name() *pulumi.StringOutput

The name of the configuration

func (*Configuration) Tags added in v0.16.8

func (r *Configuration) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Configuration) URN

func (r *Configuration) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ConfigurationArgs

type ConfigurationArgs struct {
	// The broker configuration in XML format.
	// See [official docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html)
	// for supported parameters and format of the XML.
	Data interface{}
	// The description of the configuration.
	Description interface{}
	// The type of broker engine.
	EngineType interface{}
	// The version of the broker engine.
	EngineVersion interface{}
	// The name of the configuration
	Name interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a Configuration resource.

type ConfigurationState

type ConfigurationState struct {
	// The ARN of the configuration.
	Arn interface{}
	// The broker configuration in XML format.
	// See [official docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html)
	// for supported parameters and format of the XML.
	Data interface{}
	// The description of the configuration.
	Description interface{}
	// The type of broker engine.
	EngineType interface{}
	// The version of the broker engine.
	EngineVersion interface{}
	// The latest revision of the configuration.
	LatestRevision interface{}
	// The name of the configuration
	Name interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering Configuration resources.

type GetBrokerArgs

type GetBrokerArgs struct {
	// The unique id of the mq broker.
	BrokerId interface{}
	// The unique name of the mq broker.
	BrokerName interface{}
	Logs       interface{}
	Tags       interface{}
}

A collection of arguments for invoking getBroker.

type GetBrokerResult

type GetBrokerResult struct {
	Arn                        interface{}
	AutoMinorVersionUpgrade    interface{}
	BrokerId                   interface{}
	BrokerName                 interface{}
	Configuration              interface{}
	DeploymentMode             interface{}
	EngineType                 interface{}
	EngineVersion              interface{}
	HostInstanceType           interface{}
	Instances                  interface{}
	MaintenanceWindowStartTime interface{}
	PubliclyAccessible         interface{}
	SecurityGroups             interface{}
	SubnetIds                  interface{}
	Tags                       interface{}
	Users                      interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getBroker.

func LookupBroker

func LookupBroker(ctx *pulumi.Context, args *GetBrokerArgs) (*GetBrokerResult, error)

Provides information about a MQ Broker.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL