Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. Subscription
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.Subscription

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Subscriptions allow you to be notified of new messages or changes via a Message Queue of your choice. Subscriptions are used to trigger an asynchronous background process in response to an event on the commercetools platform. Common use cases include sending an Order Confirmation Email, charging a Credit Card after the delivery has been made, or synchronizing customer accounts to a Customer Relationship Management (CRM) system.

    See also the Subscriptions API Documentation

    Example Usage

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

const my_sqs_subscription = new commercetools.Subscription("my-sqs-subscription", {
    key: "my-sqs-subscription-key",
    destinations: [{
        type: "SQS",
        queueUrl: aws_sqs_queue["your-queue"].id,
        accessKey: aws_iam_access_key.ct.id,
        accessSecret: aws_iam_access_key.ct.secret,
        region: "eu-west-1",
    }],
    changes: [{
        resourceTypeIds: ["product"],
    }],
    messages: [{
        resourceTypeId: "product",
        types: [
            "ProductPublished",
            "ProductCreated",
        ],
    }],
});

    import pulumi
import pulumi_commercetools as commercetools

my_sqs_subscription = commercetools.Subscription("my-sqs-subscription",
    key="my-sqs-subscription-key",
    destinations=[{
        "type": "SQS",
        "queue_url": aws_sqs_queue["your-queue"]["id"],
        "access_key": aws_iam_access_key["ct"]["id"],
        "access_secret": aws_iam_access_key["ct"]["secret"],
        "region": "eu-west-1",
    }],
    changes=[{
        "resource_type_ids": ["product"],
    }],
    messages=[{
        "resource_type_id": "product",
        "types": [
            "ProductPublished",
            "ProductCreated",
        ],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := commercetools.NewSubscription(ctx, "my-sqs-subscription", &commercetools.SubscriptionArgs{
			Key: pulumi.String("my-sqs-subscription-key"),
			Destinations: commercetools.SubscriptionDestinationArray{
				&commercetools.SubscriptionDestinationArgs{
					Type:         pulumi.String("SQS"),
					QueueUrl:     pulumi.Any(aws_sqs_queue.YourQueue.Id),
					AccessKey:    pulumi.Any(aws_iam_access_key.Ct.Id),
					AccessSecret: pulumi.Any(aws_iam_access_key.Ct.Secret),
					Region:       pulumi.String("eu-west-1"),
				},
			},
			Changes: commercetools.SubscriptionChangeArray{
				&commercetools.SubscriptionChangeArgs{
					ResourceTypeIds: pulumi.StringArray{
						pulumi.String("product"),
					},
				},
			},
			Messages: commercetools.SubscriptionMessageArray{
				&commercetools.SubscriptionMessageArgs{
					ResourceTypeId: pulumi.String("product"),
					Types: pulumi.StringArray{
						pulumi.String("ProductPublished"),
						pulumi.String("ProductCreated"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var my_sqs_subscription = new Commercetools.Subscription("my-sqs-subscription", new()
    {
        Key = "my-sqs-subscription-key",
        Destinations = new[]
        {
            new Commercetools.Inputs.SubscriptionDestinationArgs
            {
                Type = "SQS",
                QueueUrl = aws_sqs_queue.Your_queue.Id,
                AccessKey = aws_iam_access_key.Ct.Id,
                AccessSecret = aws_iam_access_key.Ct.Secret,
                Region = "eu-west-1",
            },
        },
        Changes = new[]
        {
            new Commercetools.Inputs.SubscriptionChangeArgs
            {
                ResourceTypeIds = new[]
                {
                    "product",
                },
            },
        },
        Messages = new[]
        {
            new Commercetools.Inputs.SubscriptionMessageArgs
            {
                ResourceTypeId = "product",
                Types = new[]
                {
                    "ProductPublished",
                    "ProductCreated",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.Subscription;
import com.pulumi.commercetools.SubscriptionArgs;
import com.pulumi.commercetools.inputs.SubscriptionDestinationArgs;
import com.pulumi.commercetools.inputs.SubscriptionChangeArgs;
import com.pulumi.commercetools.inputs.SubscriptionMessageArgs;
import java.util.List;
import java.util.ArrayList;
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 my_sqs_subscription = new Subscription("my-sqs-subscription", SubscriptionArgs.builder()
            .key("my-sqs-subscription-key")
            .destinations(SubscriptionDestinationArgs.builder()
                .type("SQS")
                .queueUrl(aws_sqs_queue.your-queue().id())
                .accessKey(aws_iam_access_key.ct().id())
                .accessSecret(aws_iam_access_key.ct().secret())
                .region("eu-west-1")
                .build())
            .changes(SubscriptionChangeArgs.builder()
                .resourceTypeIds("product")
                .build())
            .messages(SubscriptionMessageArgs.builder()
                .resourceTypeId("product")
                .types(                
                    "ProductPublished",
                    "ProductCreated")
                .build())
            .build());

    }
}

    resources:
  my-sqs-subscription:
    type: commercetools:Subscription
    properties:
      key: my-sqs-subscription-key
      destinations:
        - type: SQS
          queueUrl: ${aws_sqs_queue"your-queue"[%!s(MISSING)].id}
          accessKey: ${aws_iam_access_key.ct.id}
          accessSecret: ${aws_iam_access_key.ct.secret}
          region: eu-west-1
      changes:
        - resourceTypeIds:
            - product
      messages:
        - resourceTypeId: product
          types:
            - ProductPublished
            - ProductCreated

    Create Subscription Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Subscription(name: string, args?: SubscriptionArgs, opts?: CustomResourceOptions);
    @overload
def Subscription(resource_name: str,
                 args: Optional[SubscriptionArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 changes: Optional[Sequence[SubscriptionChangeArgs]] = None,
                 destinations: Optional[Sequence[SubscriptionDestinationArgs]] = None,
                 formats: Optional[Sequence[SubscriptionFormatArgs]] = None,
                 key: Optional[str] = None,
                 messages: Optional[Sequence[SubscriptionMessageArgs]] = None)
    func NewSubscription(ctx *Context, name string, args *SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
    public Subscription(string name, SubscriptionArgs? args = null, CustomResourceOptions? opts = null)
    public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

    type: commercetools:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SubscriptionArgs
    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 SubscriptionArgs
    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 SubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SubscriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var subscriptionResource = new Commercetools.Subscription("subscriptionResource", new()
{
    Changes = new[]
    {
        new Commercetools.Inputs.SubscriptionChangeArgs
        {
            ResourceTypeIds = new[]
            {
                "string",
            },
        },
    },
    Destinations = new[]
    {
        new Commercetools.Inputs.SubscriptionDestinationArgs
        {
            Type = "string",
            Key = "string",
            ProjectId = "string",
            Acks = "string",
            ApiKey = "string",
            ApiSecret = "string",
            BootstrapServer = "string",
            AccountId = "string",
            AccessKey = "string",
            ConnectionString = "string",
            QueueUrl = "string",
            Region = "string",
            Topic = "string",
            TopicArn = "string",
            AccessSecret = "string",
            Uri = "string",
        },
    },
    Formats = new[]
    {
        new Commercetools.Inputs.SubscriptionFormatArgs
        {
            CloudEventsVersion = "string",
            Type = "string",
        },
    },
    Key = "string",
    Messages = new[]
    {
        new Commercetools.Inputs.SubscriptionMessageArgs
        {
            ResourceTypeId = "string",
            Types = new[]
            {
                "string",
            },
        },
    },
});

    example, err := commercetools.NewSubscription(ctx, "subscriptionResource", &commercetools.SubscriptionArgs{
Changes: .SubscriptionChangeArray{
&.SubscriptionChangeArgs{
ResourceTypeIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Destinations: .SubscriptionDestinationArray{
&.SubscriptionDestinationArgs{
Type: pulumi.String("string"),
Key: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Acks: pulumi.String("string"),
ApiKey: pulumi.String("string"),
ApiSecret: pulumi.String("string"),
BootstrapServer: pulumi.String("string"),
AccountId: pulumi.String("string"),
AccessKey: pulumi.String("string"),
ConnectionString: pulumi.String("string"),
QueueUrl: pulumi.String("string"),
Region: pulumi.String("string"),
Topic: pulumi.String("string"),
TopicArn: pulumi.String("string"),
AccessSecret: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
Formats: .SubscriptionFormatArray{
&.SubscriptionFormatArgs{
CloudEventsVersion: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Key: pulumi.String("string"),
Messages: .SubscriptionMessageArray{
&.SubscriptionMessageArgs{
ResourceTypeId: pulumi.String("string"),
Types: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})

    var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
    .changes(SubscriptionChangeArgs.builder()
        .resourceTypeIds("string")
        .build())
    .destinations(SubscriptionDestinationArgs.builder()
        .type("string")
        .key("string")
        .projectId("string")
        .acks("string")
        .apiKey("string")
        .apiSecret("string")
        .bootstrapServer("string")
        .accountId("string")
        .accessKey("string")
        .connectionString("string")
        .queueUrl("string")
        .region("string")
        .topic("string")
        .topicArn("string")
        .accessSecret("string")
        .uri("string")
        .build())
    .formats(SubscriptionFormatArgs.builder()
        .cloudEventsVersion("string")
        .type("string")
        .build())
    .key("string")
    .messages(SubscriptionMessageArgs.builder()
        .resourceTypeId("string")
        .types("string")
        .build())
    .build());

    subscription_resource = commercetools.Subscription("subscriptionResource",
    changes=[{
        "resource_type_ids": ["string"],
    }],
    destinations=[{
        "type": "string",
        "key": "string",
        "project_id": "string",
        "acks": "string",
        "api_key": "string",
        "api_secret": "string",
        "bootstrap_server": "string",
        "account_id": "string",
        "access_key": "string",
        "connection_string": "string",
        "queue_url": "string",
        "region": "string",
        "topic": "string",
        "topic_arn": "string",
        "access_secret": "string",
        "uri": "string",
    }],
    formats=[{
        "cloud_events_version": "string",
        "type": "string",
    }],
    key="string",
    messages=[{
        "resource_type_id": "string",
        "types": ["string"],
    }])

    const subscriptionResource = new commercetools.Subscription("subscriptionResource", {
    changes: [{
        resourceTypeIds: ["string"],
    }],
    destinations: [{
        type: "string",
        key: "string",
        projectId: "string",
        acks: "string",
        apiKey: "string",
        apiSecret: "string",
        bootstrapServer: "string",
        accountId: "string",
        accessKey: "string",
        connectionString: "string",
        queueUrl: "string",
        region: "string",
        topic: "string",
        topicArn: "string",
        accessSecret: "string",
        uri: "string",
    }],
    formats: [{
        cloudEventsVersion: "string",
        type: "string",
    }],
    key: "string",
    messages: [{
        resourceTypeId: "string",
        types: ["string"],
    }],
});

    type: commercetools:Subscription
properties:
    changes:
        - resourceTypeIds:
            - string
    destinations:
        - accessKey: string
          accessSecret: string
          accountId: string
          acks: string
          apiKey: string
          apiSecret: string
          bootstrapServer: string
          connectionString: string
          key: string
          projectId: string
          queueUrl: string
          region: string
          topic: string
          topicArn: string
          type: string
          uri: string
    formats:
        - cloudEventsVersion: string
          type: string
    key: string
    messages:
        - resourceTypeId: string
          types:
            - string

    Subscription Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Subscription resource accepts the following input properties:

    Changes List<SubscriptionChange>
    The change notifications subscribed to
    Destinations List<SubscriptionDestination>
    Formats List<SubscriptionFormat>
    The format in which the payload is delivered
    Key string
    Messages List<SubscriptionMessage>
    The messages subscribed to
    Changes []SubscriptionChangeArgs
    The change notifications subscribed to
    Destinations []SubscriptionDestinationArgs
    Formats []SubscriptionFormatArgs
    The format in which the payload is delivered
    Key string
    Messages []SubscriptionMessageArgs
    The messages subscribed to
    changes List<SubscriptionChange>
    The change notifications subscribed to
    destinations List<SubscriptionDestination>
    formats List<SubscriptionFormat>
    The format in which the payload is delivered
    key String
    messages List<SubscriptionMessage>
    The messages subscribed to
    changes SubscriptionChange[]
    The change notifications subscribed to
    destinations SubscriptionDestination[]
    formats SubscriptionFormat[]
    The format in which the payload is delivered
    key string
    messages SubscriptionMessage[]
    The messages subscribed to
    changes List<Property Map>
    The change notifications subscribed to
    destinations List<Property Map>
    formats List<Property Map>
    The format in which the payload is delivered
    key String
    messages List<Property Map>
    The messages subscribed to

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing Subscription Resource

    Get an existing Subscription 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?: SubscriptionState, opts?: CustomResourceOptions): Subscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        changes: Optional[Sequence[SubscriptionChangeArgs]] = None,
        destinations: Optional[Sequence[SubscriptionDestinationArgs]] = None,
        formats: Optional[Sequence[SubscriptionFormatArgs]] = None,
        key: Optional[str] = None,
        messages: Optional[Sequence[SubscriptionMessageArgs]] = None,
        version: Optional[float] = None) -> Subscription
    func GetSubscription(ctx *Context, name string, id IDInput, state *SubscriptionState, opts ...ResourceOption) (*Subscription, error)
    public static Subscription Get(string name, Input<string> id, SubscriptionState? state, CustomResourceOptions? opts = null)
    public static Subscription get(String name, Output<String> id, SubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:Subscription    get:      id: ${id}
    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:
    Changes List<SubscriptionChange>
    The change notifications subscribed to
    Destinations List<SubscriptionDestination>
    Formats List<SubscriptionFormat>
    The format in which the payload is delivered
    Key string
    Messages List<SubscriptionMessage>
    The messages subscribed to
    Version double
    Changes []SubscriptionChangeArgs
    The change notifications subscribed to
    Destinations []SubscriptionDestinationArgs
    Formats []SubscriptionFormatArgs
    The format in which the payload is delivered
    Key string
    Messages []SubscriptionMessageArgs
    The messages subscribed to
    Version float64
    changes List<SubscriptionChange>
    The change notifications subscribed to
    destinations List<SubscriptionDestination>
    formats List<SubscriptionFormat>
    The format in which the payload is delivered
    key String
    messages List<SubscriptionMessage>
    The messages subscribed to
    version Double
    changes SubscriptionChange[]
    The change notifications subscribed to
    destinations SubscriptionDestination[]
    formats SubscriptionFormat[]
    The format in which the payload is delivered
    key string
    messages SubscriptionMessage[]
    The messages subscribed to
    version number
    changes List<Property Map>
    The change notifications subscribed to
    destinations List<Property Map>
    formats List<Property Map>
    The format in which the payload is delivered
    key String
    messages List<Property Map>
    The messages subscribed to
    version Number

    Supporting Types

    SubscriptionChange, SubscriptionChangeArgs

    SubscriptionDestination, SubscriptionDestinationArgs

    Type string
    The type of the destination. See Destination for more information
    AccessKey string
    The access key of the SQS queue, SNS topic or EventBridge topic
    AccessSecret string
    The access secret of the SQS queue, SNS topic or EventBridge topic
    AccountId string
    The AWS account ID of the SNS topic or EventBridge topic
    Acks string
    The acks value of the Confluent Cloud topic
    ApiKey string
    The API key of the Confluent Cloud topic
    ApiSecret string
    The API secret of the Confluent Cloud topic
    BootstrapServer string
    The bootstrap server of the Confluent Cloud topic
    ConnectionString string
    The connection string of the Azure Service Bus
    Key string
    The key of the Confluent Cloud topic
    ProjectId string
    The project ID of the Google Cloud Pub/Sub
    QueueUrl string
    The URL of the SQS queue
    Region string
    The region of the SQS queue, SNS topic or EventBridge topic
    Topic string
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    TopicArn string
    The ARN of the SNS topic
    Uri string
    The URI of the EventGrid topic
    Type string
    The type of the destination. See Destination for more information
    AccessKey string
    The access key of the SQS queue, SNS topic or EventBridge topic
    AccessSecret string
    The access secret of the SQS queue, SNS topic or EventBridge topic
    AccountId string
    The AWS account ID of the SNS topic or EventBridge topic
    Acks string
    The acks value of the Confluent Cloud topic
    ApiKey string
    The API key of the Confluent Cloud topic
    ApiSecret string
    The API secret of the Confluent Cloud topic
    BootstrapServer string
    The bootstrap server of the Confluent Cloud topic
    ConnectionString string
    The connection string of the Azure Service Bus
    Key string
    The key of the Confluent Cloud topic
    ProjectId string
    The project ID of the Google Cloud Pub/Sub
    QueueUrl string
    The URL of the SQS queue
    Region string
    The region of the SQS queue, SNS topic or EventBridge topic
    Topic string
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    TopicArn string
    The ARN of the SNS topic
    Uri string
    The URI of the EventGrid topic
    type String
    The type of the destination. See Destination for more information
    accessKey String
    The access key of the SQS queue, SNS topic or EventBridge topic
    accessSecret String
    The access secret of the SQS queue, SNS topic or EventBridge topic
    accountId String
    The AWS account ID of the SNS topic or EventBridge topic
    acks String
    The acks value of the Confluent Cloud topic
    apiKey String
    The API key of the Confluent Cloud topic
    apiSecret String
    The API secret of the Confluent Cloud topic
    bootstrapServer String
    The bootstrap server of the Confluent Cloud topic
    connectionString String
    The connection string of the Azure Service Bus
    key String
    The key of the Confluent Cloud topic
    projectId String
    The project ID of the Google Cloud Pub/Sub
    queueUrl String
    The URL of the SQS queue
    region String
    The region of the SQS queue, SNS topic or EventBridge topic
    topic String
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    topicArn String
    The ARN of the SNS topic
    uri String
    The URI of the EventGrid topic
    type string
    The type of the destination. See Destination for more information
    accessKey string
    The access key of the SQS queue, SNS topic or EventBridge topic
    accessSecret string
    The access secret of the SQS queue, SNS topic or EventBridge topic
    accountId string
    The AWS account ID of the SNS topic or EventBridge topic
    acks string
    The acks value of the Confluent Cloud topic
    apiKey string
    The API key of the Confluent Cloud topic
    apiSecret string
    The API secret of the Confluent Cloud topic
    bootstrapServer string
    The bootstrap server of the Confluent Cloud topic
    connectionString string
    The connection string of the Azure Service Bus
    key string
    The key of the Confluent Cloud topic
    projectId string
    The project ID of the Google Cloud Pub/Sub
    queueUrl string
    The URL of the SQS queue
    region string
    The region of the SQS queue, SNS topic or EventBridge topic
    topic string
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    topicArn string
    The ARN of the SNS topic
    uri string
    The URI of the EventGrid topic
    type str
    The type of the destination. See Destination for more information
    access_key str
    The access key of the SQS queue, SNS topic or EventBridge topic
    access_secret str
    The access secret of the SQS queue, SNS topic or EventBridge topic
    account_id str
    The AWS account ID of the SNS topic or EventBridge topic
    acks str
    The acks value of the Confluent Cloud topic
    api_key str
    The API key of the Confluent Cloud topic
    api_secret str
    The API secret of the Confluent Cloud topic
    bootstrap_server str
    The bootstrap server of the Confluent Cloud topic
    connection_string str
    The connection string of the Azure Service Bus
    key str
    The key of the Confluent Cloud topic
    project_id str
    The project ID of the Google Cloud Pub/Sub
    queue_url str
    The URL of the SQS queue
    region str
    The region of the SQS queue, SNS topic or EventBridge topic
    topic str
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    topic_arn str
    The ARN of the SNS topic
    uri str
    The URI of the EventGrid topic
    type String
    The type of the destination. See Destination for more information
    accessKey String
    The access key of the SQS queue, SNS topic or EventBridge topic
    accessSecret String
    The access secret of the SQS queue, SNS topic or EventBridge topic
    accountId String
    The AWS account ID of the SNS topic or EventBridge topic
    acks String
    The acks value of the Confluent Cloud topic
    apiKey String
    The API key of the Confluent Cloud topic
    apiSecret String
    The API secret of the Confluent Cloud topic
    bootstrapServer String
    The bootstrap server of the Confluent Cloud topic
    connectionString String
    The connection string of the Azure Service Bus
    key String
    The key of the Confluent Cloud topic
    projectId String
    The project ID of the Google Cloud Pub/Sub
    queueUrl String
    The URL of the SQS queue
    region String
    The region of the SQS queue, SNS topic or EventBridge topic
    topic String
    The topic of the Google Cloud Pub/Sub or Confluent Cloud topic
    topicArn String
    The ARN of the SNS topic
    uri String
    The URI of the EventGrid topic

    SubscriptionFormat, SubscriptionFormatArgs

    CloudEventsVersion string
    For CloudEvents
    Type string
    CloudEventsVersion string
    For CloudEvents
    Type string
    cloudEventsVersion String
    For CloudEvents
    type String
    cloudEventsVersion string
    For CloudEvents
    type string
    cloud_events_version str
    For CloudEvents
    type str
    cloudEventsVersion String
    For CloudEvents
    type String

    SubscriptionMessage, SubscriptionMessageArgs

    ResourceTypeId string
    Resource Type ID
    Types List<string>
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource
    ResourceTypeId string
    Resource Type ID
    Types []string
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource
    resourceTypeId String
    Resource Type ID
    types List<String>
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource
    resourceTypeId string
    Resource Type ID
    types string[]
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource
    resource_type_id str
    Resource Type ID
    types Sequence[str]
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource
    resourceTypeId String
    Resource Type ID
    types List<String>
    types must contain valid message types for this resource, for example for resource type product the message type ProductPublished is valid. If no types of messages are given, the subscription is valid for all messages of this resource

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools