Package @pulumi/cloudamqp

This provider is a derived work of the Terraform Provider distributed under MIT. If you encounter a bug or missing feature, first check the pulumi/pulumi-cloudamqp repo; however, if that doesn’t turn up anything, please consult the source cloudamqp/terraform-provider-cloudamqp repo.

var cloudamqp = require("@pulumi/cloudamqp");
import * as cloudamqp from "@pulumi/cloudamqp";

Modules

Resources

Data Sources

Others

Resources

Resource Alarm

class Alarm extends CustomResource

constructor

new Alarm(name: string, args: AlarmArgs, opts?: pulumi.CustomResourceOptions)

Create a Alarm resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlarmState, opts?: pulumi.CustomResourceOptions): Alarm

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Alarm

Returns true if the given object is an instance of Alarm. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

Enable or disable an alarm

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property messageType

public messageType: pulumi.Output<string | undefined>;

Message types (total, unacked, ready) of the queue to trigger the alarm

property queueRegex

public queueRegex: pulumi.Output<string | undefined>;

Regex for which queues to check

property recipients

public recipients: pulumi.Output<number[]>;

Identifiers for recipients to be notified.

property timeThreshold

public timeThreshold: pulumi.Output<number | undefined>;

For how long (in seconds) the value_threshold should be active before trigger alarm

property type

public type: pulumi.Output<string>;

Type of the alarm, valid options are: cpu, memory, disk_usage, queue_length, connection_count, consumers_count, net_split

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueThreshold

public valueThreshold: pulumi.Output<number | undefined>;

What value to trigger the alarm for

property vhostRegex

public vhostRegex: pulumi.Output<string | undefined>;

Regex for which vhost the queues are in

Resource Instance

class Instance extends CustomResource

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apikey

public apikey: pulumi.Output<string>;

API key for the CloudAMQP instance

property host

public host: pulumi.Output<string>;

Host name for the CloudAMQP instance

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the instance

property nodes

public nodes: pulumi.Output<number | undefined>;

Number of nodes in cluster (plan must support it)

property plan

public plan: pulumi.Output<string>;

Name of the plan, valid options are: lemur, tiger, bunny, rabbit, panda, ape, hippo, lion

property region

public region: pulumi.Output<string>;

Name of the region you want to create your instance in

property rmqVersion

public rmqVersion: pulumi.Output<string | undefined>;

RabbitMQ version

property tags

public tags: pulumi.Output<string[] | undefined>;

Tag the instances with optional tags

property url

public url: pulumi.Output<string>;

URL of the CloudAMQP instance

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vhost

public vhost: pulumi.Output<string>;

The virtual host

property vpcSubnet

public vpcSubnet: pulumi.Output<string | undefined>;

Dedicated VPC subnet, shouldn’t overlap with your current VPC’s subnet

Resource Notification

class Notification extends CustomResource

constructor

new Notification(name: string, args: NotificationArgs, opts?: pulumi.CustomResourceOptions)

Create a Notification resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotificationState, opts?: pulumi.CustomResourceOptions): Notification

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Notification

Returns true if the given object is an instance of Notification. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property name

public name: pulumi.Output<string>;

Optional display name of the recipient

property type

public type: pulumi.Output<string>;

Type of the notification, valid options are: email, webhook, pagerduty, victorops, opsgenie, opsgenie-eu, slack

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

Notification endpoint, where to send the notifcation

Resource Plugin

class Plugin extends CustomResource

constructor

new Plugin(name: string, args: PluginArgs, opts?: pulumi.CustomResourceOptions)

Create a Plugin resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PluginState, opts?: pulumi.CustomResourceOptions): Plugin

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Plugin

Returns true if the given object is an instance of Plugin. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

If the plugin is enabled

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property name

public name: pulumi.Output<string>;

The name of the plugin

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource PluginCommunity

class PluginCommunity extends CustomResource

constructor

new PluginCommunity(name: string, args: PluginCommunityArgs, opts?: pulumi.CustomResourceOptions)

Create a PluginCommunity resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PluginCommunityState, opts?: pulumi.CustomResourceOptions): PluginCommunity

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is PluginCommunity

Returns true if the given object is an instance of PluginCommunity. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property enabled

public enabled: pulumi.Output<boolean>;

If the plugin is enabled

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property name

public name: pulumi.Output<string>;

The name of the plugin

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the cloudamqp package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

This content is derived from https://github.com/cloudamqp/terraform-provider-cloudamqp/blob/master/website/docs/index.html.markdown.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SecurityFirewall

class SecurityFirewall extends CustomResource

constructor

new SecurityFirewall(name: string, args: SecurityFirewallArgs, opts?: pulumi.CustomResourceOptions)

Create a SecurityFirewall resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecurityFirewallState, opts?: pulumi.CustomResourceOptions): SecurityFirewall

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecurityFirewall

Returns true if the given object is an instance of SecurityFirewall. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property rules

public rules: pulumi.Output<SecurityFirewallRule[]>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource VpcPeering

class VpcPeering extends CustomResource

constructor

new VpcPeering(name: string, args: VpcPeeringArgs, opts?: pulumi.CustomResourceOptions)

Create a VpcPeering resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcPeeringState, opts?: pulumi.CustomResourceOptions): VpcPeering

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VpcPeering

Returns true if the given object is an instance of VpcPeering. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<number>;

Instance identifier

property peeringId

public peeringId: pulumi.Output<string>;

VPC peering identifier

property status

public status: pulumi.Output<string>;

VPC peering status

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Data Sources

Data Source getCredentials

getCredentials(args: GetCredentialsArgs, opts?: pulumi.InvokeOptions): Promise<GetCredentialsResult> & GetCredentialsResult

Data Source getInstance

getInstance(args: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceResult> & GetInstanceResult

Data Source getPlugins

getPlugins(args: GetPluginsArgs, opts?: pulumi.InvokeOptions): Promise<GetPluginsResult> & GetPluginsResult

Data Source getPluginsCommunity

getPluginsCommunity(args: GetPluginsCommunityArgs, opts?: pulumi.InvokeOptions): Promise<GetPluginsCommunityResult> & GetPluginsCommunityResult

Data Source getVpcInfo

getVpcInfo(args: GetVpcInfoArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcInfoResult> & GetVpcInfoResult

Others

interface AlarmArgs

interface AlarmArgs

The set of arguments for constructing a Alarm resource.

property enabled

enabled: pulumi.Input<boolean>;

Enable or disable an alarm

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property messageType

messageType?: pulumi.Input<string>;

Message types (total, unacked, ready) of the queue to trigger the alarm

property queueRegex

queueRegex?: pulumi.Input<string>;

Regex for which queues to check

property recipients

recipients: pulumi.Input<pulumi.Input<number>[]>;

Identifiers for recipients to be notified.

property timeThreshold

timeThreshold?: pulumi.Input<number>;

For how long (in seconds) the value_threshold should be active before trigger alarm

property type

type: pulumi.Input<string>;

Type of the alarm, valid options are: cpu, memory, disk_usage, queue_length, connection_count, consumers_count, net_split

property valueThreshold

valueThreshold?: pulumi.Input<number>;

What value to trigger the alarm for

property vhostRegex

vhostRegex?: pulumi.Input<string>;

Regex for which vhost the queues are in

interface AlarmState

interface AlarmState

Input properties used for looking up and filtering Alarm resources.

property enabled

enabled?: pulumi.Input<boolean>;

Enable or disable an alarm

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property messageType

messageType?: pulumi.Input<string>;

Message types (total, unacked, ready) of the queue to trigger the alarm

property queueRegex

queueRegex?: pulumi.Input<string>;

Regex for which queues to check

property recipients

recipients?: pulumi.Input<pulumi.Input<number>[]>;

Identifiers for recipients to be notified.

property timeThreshold

timeThreshold?: pulumi.Input<number>;

For how long (in seconds) the value_threshold should be active before trigger alarm

property type

type?: pulumi.Input<string>;

Type of the alarm, valid options are: cpu, memory, disk_usage, queue_length, connection_count, consumers_count, net_split

property valueThreshold

valueThreshold?: pulumi.Input<number>;

What value to trigger the alarm for

property vhostRegex

vhostRegex?: pulumi.Input<string>;

Regex for which vhost the queues are in

interface GetCredentialsArgs

interface GetCredentialsArgs

A collection of arguments for invoking getCredentials.

property instanceId

instanceId: number;

property password

password?: undefined | string;

property username

username?: undefined | string;

interface GetCredentialsResult

interface GetCredentialsResult

A collection of values returned by getCredentials.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property instanceId

instanceId: number;

property password

password?: undefined | string;

property username

username?: undefined | string;

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetInstanceArgs

interface GetInstanceArgs

A collection of arguments for invoking getInstance.

property instanceId

instanceId: number;

property vpcSubnet

vpcSubnet?: undefined | string;

interface GetInstanceResult

interface GetInstanceResult

A collection of values returned by getInstance.

property apikey

apikey: string;

property host

host: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property instanceId

instanceId: number;

property name

name: string;

property nodes

nodes: number;

property plan

plan: string;

property region

region: string;

property rmqVersion

rmqVersion: string;

property tags

tags: string[];

property url

url: string;

property vhost

vhost: string;

property vpcSubnet

vpcSubnet?: undefined | string;

interface GetPluginsArgs

interface GetPluginsArgs

A collection of arguments for invoking getPlugins.

property instanceId

instanceId: number;

property plugins

plugins?: GetPluginsPlugin[];

interface GetPluginsCommunityArgs

interface GetPluginsCommunityArgs

A collection of arguments for invoking getPluginsCommunity.

property instanceId

instanceId: number;

property plugins

plugins?: GetPluginsCommunityPlugin[];

interface GetPluginsCommunityResult

interface GetPluginsCommunityResult

A collection of values returned by getPluginsCommunity.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property instanceId

instanceId: number;

property plugins

plugins?: GetPluginsCommunityPlugin[];

interface GetPluginsResult

interface GetPluginsResult

A collection of values returned by getPlugins.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property instanceId

instanceId: number;

property plugins

plugins?: GetPluginsPlugin[];

function getVersion

getVersion(): string

interface GetVpcInfoArgs

interface GetVpcInfoArgs

A collection of arguments for invoking getVpcInfo.

property instanceId

instanceId: number;

interface GetVpcInfoResult

interface GetVpcInfoResult

A collection of values returned by getVpcInfo.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property instanceId

instanceId: number;

property name

name: string;

property ownerId

ownerId: string;

property securityGroupId

securityGroupId: string;

property vpcSubnet

vpcSubnet: string;

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property name

name?: pulumi.Input<string>;

Name of the instance

property nodes

nodes?: pulumi.Input<number>;

Number of nodes in cluster (plan must support it)

property plan

plan: pulumi.Input<string>;

Name of the plan, valid options are: lemur, tiger, bunny, rabbit, panda, ape, hippo, lion

property region

region: pulumi.Input<string>;

Name of the region you want to create your instance in

property rmqVersion

rmqVersion?: pulumi.Input<string>;

RabbitMQ version

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

Tag the instances with optional tags

property vpcSubnet

vpcSubnet?: pulumi.Input<string>;

Dedicated VPC subnet, shouldn’t overlap with your current VPC’s subnet

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property apikey

apikey?: pulumi.Input<string>;

API key for the CloudAMQP instance

property host

host?: pulumi.Input<string>;

Host name for the CloudAMQP instance

property name

name?: pulumi.Input<string>;

Name of the instance

property nodes

nodes?: pulumi.Input<number>;

Number of nodes in cluster (plan must support it)

property plan

plan?: pulumi.Input<string>;

Name of the plan, valid options are: lemur, tiger, bunny, rabbit, panda, ape, hippo, lion

property region

region?: pulumi.Input<string>;

Name of the region you want to create your instance in

property rmqVersion

rmqVersion?: pulumi.Input<string>;

RabbitMQ version

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

Tag the instances with optional tags

property url

url?: pulumi.Input<string>;

URL of the CloudAMQP instance

property vhost

vhost?: pulumi.Input<string>;

The virtual host

property vpcSubnet

vpcSubnet?: pulumi.Input<string>;

Dedicated VPC subnet, shouldn’t overlap with your current VPC’s subnet

interface NotificationArgs

interface NotificationArgs

The set of arguments for constructing a Notification resource.

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

Optional display name of the recipient

property type

type: pulumi.Input<string>;

Type of the notification, valid options are: email, webhook, pagerduty, victorops, opsgenie, opsgenie-eu, slack

property value

value: pulumi.Input<string>;

Notification endpoint, where to send the notifcation

interface NotificationState

interface NotificationState

Input properties used for looking up and filtering Notification resources.

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

Optional display name of the recipient

property type

type?: pulumi.Input<string>;

Type of the notification, valid options are: email, webhook, pagerduty, victorops, opsgenie, opsgenie-eu, slack

property value

value?: pulumi.Input<string>;

Notification endpoint, where to send the notifcation

interface PluginArgs

interface PluginArgs

The set of arguments for constructing a Plugin resource.

property enabled

enabled: pulumi.Input<boolean>;

If the plugin is enabled

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

The name of the plugin

interface PluginCommunityArgs

interface PluginCommunityArgs

The set of arguments for constructing a PluginCommunity resource.

property enabled

enabled: pulumi.Input<boolean>;

If the plugin is enabled

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

The name of the plugin

interface PluginCommunityState

interface PluginCommunityState

Input properties used for looking up and filtering PluginCommunity resources.

property enabled

enabled?: pulumi.Input<boolean>;

If the plugin is enabled

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

The name of the plugin

interface PluginState

interface PluginState

Input properties used for looking up and filtering Plugin resources.

property enabled

enabled?: pulumi.Input<boolean>;

If the plugin is enabled

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property name

name?: pulumi.Input<string>;

The name of the plugin

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property apikey

apikey?: pulumi.Input<string>;

Key used to authentication to the CloudAMQP Customer API

property baseurl

baseurl?: pulumi.Input<string>;

Base URL to CloudAMQP Customer website

interface SecurityFirewallArgs

interface SecurityFirewallArgs

The set of arguments for constructing a SecurityFirewall resource.

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property rules

rules: pulumi.Input<pulumi.Input<SecurityFirewallRule>[]>;

interface SecurityFirewallState

interface SecurityFirewallState

Input properties used for looking up and filtering SecurityFirewall resources.

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property rules

rules?: pulumi.Input<pulumi.Input<SecurityFirewallRule>[]>;

interface VpcPeeringArgs

interface VpcPeeringArgs

The set of arguments for constructing a VpcPeering resource.

property instanceId

instanceId: pulumi.Input<number>;

Instance identifier

property peeringId

peeringId: pulumi.Input<string>;

VPC peering identifier

interface VpcPeeringState

interface VpcPeeringState

Input properties used for looking up and filtering VpcPeering resources.

property instanceId

instanceId?: pulumi.Input<number>;

Instance identifier

property peeringId

peeringId?: pulumi.Input<string>;

VPC peering identifier

property status

status?: pulumi.Input<string>;

VPC peering status