Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. connectors
  5. connectors/v1
  6. EventSubscription

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.connectors/v1.EventSubscription

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new EventSubscription in a given project,location and connection.

    Create EventSubscription Resource

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

    Constructor syntax

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

@overload
def EventSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      connection_id: Optional[str] = None,
                      event_subscription_id: Optional[str] = None,
                      destinations: Optional[EventSubscriptionDestinationArgs] = None,
                      event_type_id: Optional[str] = None,
                      jms: Optional[JMSArgs] = None,
                      location: Optional[str] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None,
                      subscriber: Optional[str] = None,
                      subscriber_link: Optional[str] = None)
    func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)
    public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)
    public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)

    type: google-native:connectors/v1:EventSubscription
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 EventSubscriptionArgs
    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 EventSubscriptionArgs
    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 EventSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventSubscriptionArgs
    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 eventSubscriptionResource = new GoogleNative.Connectors.V1.EventSubscription("eventSubscriptionResource", new()
{
    ConnectionId = "string",
    EventSubscriptionId = "string",
    Destinations = new GoogleNative.Connectors.V1.Inputs.EventSubscriptionDestinationArgs
    {
        Endpoint = new GoogleNative.Connectors.V1.Inputs.EndPointArgs
        {
            EndpointUri = "string",
            Headers = new[]
            {
                new GoogleNative.Connectors.V1.Inputs.HeaderArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
        ServiceAccount = "string",
        Type = GoogleNative.Connectors.V1.EventSubscriptionDestinationType.TypeUnspecified,
    },
    EventTypeId = "string",
    Jms = new GoogleNative.Connectors.V1.Inputs.JMSArgs
    {
        Name = "string",
        Type = GoogleNative.Connectors.V1.JMSType.TypeUnspecified,
    },
    Location = "string",
    Name = "string",
    Project = "string",
    Subscriber = "string",
    SubscriberLink = "string",
});

    example, err := connectors.NewEventSubscription(ctx, "eventSubscriptionResource", &connectors.EventSubscriptionArgs{
	ConnectionId:        pulumi.String("string"),
	EventSubscriptionId: pulumi.String("string"),
	Destinations: &connectors.EventSubscriptionDestinationArgs{
		Endpoint: &connectors.EndPointArgs{
			EndpointUri: pulumi.String("string"),
			Headers: connectors.HeaderArray{
				&connectors.HeaderArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
		ServiceAccount: pulumi.String("string"),
		Type:           connectors.EventSubscriptionDestinationTypeTypeUnspecified,
	},
	EventTypeId: pulumi.String("string"),
	Jms: &connectors.JMSArgs{
		Name: pulumi.String("string"),
		Type: connectors.JMSTypeTypeUnspecified,
	},
	Location:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	Project:        pulumi.String("string"),
	Subscriber:     pulumi.String("string"),
	SubscriberLink: pulumi.String("string"),
})

    var eventSubscriptionResource = new EventSubscription("eventSubscriptionResource", EventSubscriptionArgs.builder()
    .connectionId("string")
    .eventSubscriptionId("string")
    .destinations(EventSubscriptionDestinationArgs.builder()
        .endpoint(EndPointArgs.builder()
            .endpointUri("string")
            .headers(HeaderArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .serviceAccount("string")
        .type("TYPE_UNSPECIFIED")
        .build())
    .eventTypeId("string")
    .jms(JMSArgs.builder()
        .name("string")
        .type("TYPE_UNSPECIFIED")
        .build())
    .location("string")
    .name("string")
    .project("string")
    .subscriber("string")
    .subscriberLink("string")
    .build());

    event_subscription_resource = google_native.connectors.v1.EventSubscription("eventSubscriptionResource",
    connection_id="string",
    event_subscription_id="string",
    destinations={
        "endpoint": {
            "endpoint_uri": "string",
            "headers": [{
                "key": "string",
                "value": "string",
            }],
        },
        "service_account": "string",
        "type": google_native.connectors.v1.EventSubscriptionDestinationType.TYPE_UNSPECIFIED,
    },
    event_type_id="string",
    jms={
        "name": "string",
        "type": google_native.connectors.v1.JMSType.TYPE_UNSPECIFIED,
    },
    location="string",
    name="string",
    project="string",
    subscriber="string",
    subscriber_link="string")

    const eventSubscriptionResource = new google_native.connectors.v1.EventSubscription("eventSubscriptionResource", {
    connectionId: "string",
    eventSubscriptionId: "string",
    destinations: {
        endpoint: {
            endpointUri: "string",
            headers: [{
                key: "string",
                value: "string",
            }],
        },
        serviceAccount: "string",
        type: google_native.connectors.v1.EventSubscriptionDestinationType.TypeUnspecified,
    },
    eventTypeId: "string",
    jms: {
        name: "string",
        type: google_native.connectors.v1.JMSType.TypeUnspecified,
    },
    location: "string",
    name: "string",
    project: "string",
    subscriber: "string",
    subscriberLink: "string",
});

    type: google-native:connectors/v1:EventSubscription
properties:
    connectionId: string
    destinations:
        endpoint:
            endpointUri: string
            headers:
                - key: string
                  value: string
        serviceAccount: string
        type: TYPE_UNSPECIFIED
    eventSubscriptionId: string
    eventTypeId: string
    jms:
        name: string
        type: TYPE_UNSPECIFIED
    location: string
    name: string
    project: string
    subscriber: string
    subscriberLink: string

    EventSubscription 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 EventSubscription resource accepts the following input properties:

    ConnectionId string
    EventSubscriptionId string
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    Destinations Pulumi.GoogleNative.Connectors.V1.Inputs.EventSubscriptionDestination
    Optional. The destination to hit when we receive an event
    EventTypeId string
    Optional. Event type id of the event of current EventSubscription.
    Jms Pulumi.GoogleNative.Connectors.V1.Inputs.JMS
    Optional. JMS is the source for the event listener.
    Location string
    Name string
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    Project string
    Subscriber string
    Optional. name of the Subscriber for the current EventSubscription.
    SubscriberLink string
    Optional. Link for Subscriber of the current EventSubscription.
    ConnectionId string
    EventSubscriptionId string
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    Destinations EventSubscriptionDestinationArgs
    Optional. The destination to hit when we receive an event
    EventTypeId string
    Optional. Event type id of the event of current EventSubscription.
    Jms JMSArgs
    Optional. JMS is the source for the event listener.
    Location string
    Name string
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    Project string
    Subscriber string
    Optional. name of the Subscriber for the current EventSubscription.
    SubscriberLink string
    Optional. Link for Subscriber of the current EventSubscription.
    connectionId String
    eventSubscriptionId String
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    destinations EventSubscriptionDestination
    Optional. The destination to hit when we receive an event
    eventTypeId String
    Optional. Event type id of the event of current EventSubscription.
    jms JMS
    Optional. JMS is the source for the event listener.
    location String
    name String
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    project String
    subscriber String
    Optional. name of the Subscriber for the current EventSubscription.
    subscriberLink String
    Optional. Link for Subscriber of the current EventSubscription.
    connectionId string
    eventSubscriptionId string
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    destinations EventSubscriptionDestination
    Optional. The destination to hit when we receive an event
    eventTypeId string
    Optional. Event type id of the event of current EventSubscription.
    jms JMS
    Optional. JMS is the source for the event listener.
    location string
    name string
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    project string
    subscriber string
    Optional. name of the Subscriber for the current EventSubscription.
    subscriberLink string
    Optional. Link for Subscriber of the current EventSubscription.
    connection_id str
    event_subscription_id str
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    destinations EventSubscriptionDestinationArgs
    Optional. The destination to hit when we receive an event
    event_type_id str
    Optional. Event type id of the event of current EventSubscription.
    jms JMSArgs
    Optional. JMS is the source for the event listener.
    location str
    name str
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    project str
    subscriber str
    Optional. name of the Subscriber for the current EventSubscription.
    subscriber_link str
    Optional. Link for Subscriber of the current EventSubscription.
    connectionId String
    eventSubscriptionId String
    Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
    destinations Property Map
    Optional. The destination to hit when we receive an event
    eventTypeId String
    Optional. Event type id of the event of current EventSubscription.
    jms Property Map
    Optional. JMS is the source for the event listener.
    location String
    name String
    Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
    project String
    subscriber String
    Optional. name of the Subscriber for the current EventSubscription.
    subscriberLink String
    Optional. Link for Subscriber of the current EventSubscription.

    Outputs

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

    CreateTime string
    Created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.GoogleNative.Connectors.V1.Outputs.EventSubscriptionStatusResponse
    Optional. Status indicates the status of the event subscription resource
    UpdateTime string
    Updated time.
    CreateTime string
    Created time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status EventSubscriptionStatusResponse
    Optional. Status indicates the status of the event subscription resource
    UpdateTime string
    Updated time.
    createTime String
    Created time.
    id String
    The provider-assigned unique ID for this managed resource.
    status EventSubscriptionStatusResponse
    Optional. Status indicates the status of the event subscription resource
    updateTime String
    Updated time.
    createTime string
    Created time.
    id string
    The provider-assigned unique ID for this managed resource.
    status EventSubscriptionStatusResponse
    Optional. Status indicates the status of the event subscription resource
    updateTime string
    Updated time.
    create_time str
    Created time.
    id str
    The provider-assigned unique ID for this managed resource.
    status EventSubscriptionStatusResponse
    Optional. Status indicates the status of the event subscription resource
    update_time str
    Updated time.
    createTime String
    Created time.
    id String
    The provider-assigned unique ID for this managed resource.
    status Property Map
    Optional. Status indicates the status of the event subscription resource
    updateTime String
    Updated time.

    Supporting Types

    EndPoint, EndPointArgs

    EndpointUri string
    The URI of the Endpoint.
    Headers List<Pulumi.GoogleNative.Connectors.V1.Inputs.Header>
    List of Header to be added to the Endpoint.
    EndpointUri string
    The URI of the Endpoint.
    Headers []Header
    List of Header to be added to the Endpoint.
    endpointUri String
    The URI of the Endpoint.
    headers List<Header>
    List of Header to be added to the Endpoint.
    endpointUri string
    The URI of the Endpoint.
    headers Header[]
    List of Header to be added to the Endpoint.
    endpoint_uri str
    The URI of the Endpoint.
    headers Sequence[Header]
    List of Header to be added to the Endpoint.
    endpointUri String
    The URI of the Endpoint.
    headers List<Property Map>
    List of Header to be added to the Endpoint.

    EndPointResponse, EndPointResponseArgs

    EndpointUri string
    The URI of the Endpoint.
    Headers List<Pulumi.GoogleNative.Connectors.V1.Inputs.HeaderResponse>
    List of Header to be added to the Endpoint.
    EndpointUri string
    The URI of the Endpoint.
    Headers []HeaderResponse
    List of Header to be added to the Endpoint.
    endpointUri String
    The URI of the Endpoint.
    headers List<HeaderResponse>
    List of Header to be added to the Endpoint.
    endpointUri string
    The URI of the Endpoint.
    headers HeaderResponse[]
    List of Header to be added to the Endpoint.
    endpoint_uri str
    The URI of the Endpoint.
    headers Sequence[HeaderResponse]
    List of Header to be added to the Endpoint.
    endpointUri String
    The URI of the Endpoint.
    headers List<Property Map>
    List of Header to be added to the Endpoint.

    EventSubscriptionDestination, EventSubscriptionDestinationArgs

    Endpoint Pulumi.GoogleNative.Connectors.V1.Inputs.EndPoint
    OPTION 1: Hit an endpoint when we receive an event.
    ServiceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    Type Pulumi.GoogleNative.Connectors.V1.EventSubscriptionDestinationType
    type of the destination
    Endpoint EndPoint
    OPTION 1: Hit an endpoint when we receive an event.
    ServiceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    Type EventSubscriptionDestinationType
    type of the destination
    endpoint EndPoint
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount String
    Service account needed for runtime plane to trigger IP workflow.
    type EventSubscriptionDestinationType
    type of the destination
    endpoint EndPoint
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    type EventSubscriptionDestinationType
    type of the destination
    endpoint EndPoint
    OPTION 1: Hit an endpoint when we receive an event.
    service_account str
    Service account needed for runtime plane to trigger IP workflow.
    type EventSubscriptionDestinationType
    type of the destination
    endpoint Property Map
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount String
    Service account needed for runtime plane to trigger IP workflow.
    type "TYPE_UNSPECIFIED" | "ENDPOINT"
    type of the destination

    EventSubscriptionDestinationResponse, EventSubscriptionDestinationResponseArgs

    Endpoint Pulumi.GoogleNative.Connectors.V1.Inputs.EndPointResponse
    OPTION 1: Hit an endpoint when we receive an event.
    ServiceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    Type string
    type of the destination
    Endpoint EndPointResponse
    OPTION 1: Hit an endpoint when we receive an event.
    ServiceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    Type string
    type of the destination
    endpoint EndPointResponse
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount String
    Service account needed for runtime plane to trigger IP workflow.
    type String
    type of the destination
    endpoint EndPointResponse
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount string
    Service account needed for runtime plane to trigger IP workflow.
    type string
    type of the destination
    endpoint EndPointResponse
    OPTION 1: Hit an endpoint when we receive an event.
    service_account str
    Service account needed for runtime plane to trigger IP workflow.
    type str
    type of the destination
    endpoint Property Map
    OPTION 1: Hit an endpoint when we receive an event.
    serviceAccount String
    Service account needed for runtime plane to trigger IP workflow.
    type String
    type of the destination

    EventSubscriptionDestinationType, EventSubscriptionDestinationTypeArgs

    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Endpoint
    ENDPOINTEndpoint - Hit the value of endpoint when event is received
    EventSubscriptionDestinationTypeTypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    EventSubscriptionDestinationTypeEndpoint
    ENDPOINTEndpoint - Hit the value of endpoint when event is received
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Endpoint
    ENDPOINTEndpoint - Hit the value of endpoint when event is received
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Endpoint
    ENDPOINTEndpoint - Hit the value of endpoint when event is received
    TYPE_UNSPECIFIED
    TYPE_UNSPECIFIEDDefault state.
    ENDPOINT
    ENDPOINTEndpoint - Hit the value of endpoint when event is received
    "TYPE_UNSPECIFIED"
    TYPE_UNSPECIFIEDDefault state.
    "ENDPOINT"
    ENDPOINTEndpoint - Hit the value of endpoint when event is received

    EventSubscriptionStatusResponse, EventSubscriptionStatusResponseArgs

    Description string
    Description of the state.
    State string
    State of Event Subscription resource.
    Description string
    Description of the state.
    State string
    State of Event Subscription resource.
    description String
    Description of the state.
    state String
    State of Event Subscription resource.
    description string
    Description of the state.
    state string
    State of Event Subscription resource.
    description str
    Description of the state.
    state str
    State of Event Subscription resource.
    description String
    Description of the state.
    state String
    State of Event Subscription resource.
    Key string
    Key of Header.
    Value string
    Value of Header.
    Key string
    Key of Header.
    Value string
    Value of Header.
    key String
    Key of Header.
    value String
    Value of Header.
    key string
    Key of Header.
    value string
    Value of Header.
    key str
    Key of Header.
    value str
    Value of Header.
    key String
    Key of Header.
    value String
    Value of Header.

    HeaderResponse, HeaderResponseArgs

    Key string
    Key of Header.
    Value string
    Value of Header.
    Key string
    Key of Header.
    Value string
    Value of Header.
    key String
    Key of Header.
    value String
    Value of Header.
    key string
    Key of Header.
    value string
    Value of Header.
    key str
    Key of Header.
    value str
    Value of Header.
    key String
    Key of Header.
    value String
    Value of Header.

    JMS, JMSArgs

    Name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    Type Pulumi.GoogleNative.Connectors.V1.JMSType
    Optional. Type of the JMS Source. i.e. Queue or Topic
    Name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    Type JMSType
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name String
    Optional. Name of the JMS source. i.e. queueName or topicName
    type JMSType
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    type JMSType
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name str
    Optional. Name of the JMS source. i.e. queueName or topicName
    type JMSType
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name String
    Optional. Name of the JMS source. i.e. queueName or topicName
    type "TYPE_UNSPECIFIED" | "QUEUE" | "TOPIC"
    Optional. Type of the JMS Source. i.e. Queue or Topic

    JMSResponse, JMSResponseArgs

    Name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    Type string
    Optional. Type of the JMS Source. i.e. Queue or Topic
    Name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    Type string
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name String
    Optional. Name of the JMS source. i.e. queueName or topicName
    type String
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name string
    Optional. Name of the JMS source. i.e. queueName or topicName
    type string
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name str
    Optional. Name of the JMS source. i.e. queueName or topicName
    type str
    Optional. Type of the JMS Source. i.e. Queue or Topic
    name String
    Optional. Name of the JMS source. i.e. queueName or topicName
    type String
    Optional. Type of the JMS Source. i.e. Queue or Topic

    JMSType, JMSTypeArgs

    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Queue
    QUEUEJMS Queue.
    Topic
    TOPICJMS Topic.
    JMSTypeTypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    JMSTypeQueue
    QUEUEJMS Queue.
    JMSTypeTopic
    TOPICJMS Topic.
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Queue
    QUEUEJMS Queue.
    Topic
    TOPICJMS Topic.
    TypeUnspecified
    TYPE_UNSPECIFIEDDefault state.
    Queue
    QUEUEJMS Queue.
    Topic
    TOPICJMS Topic.
    TYPE_UNSPECIFIED
    TYPE_UNSPECIFIEDDefault state.
    QUEUE
    QUEUEJMS Queue.
    TOPIC
    TOPICJMS Topic.
    "TYPE_UNSPECIFIED"
    TYPE_UNSPECIFIEDDefault state.
    "QUEUE"
    QUEUEJMS Queue.
    "TOPIC"
    TOPICJMS Topic.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native