Docs Packages
  1. Packages
  2. ngrok
  3. API Docs
  4. EventSubscription
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

ngrok.EventSubscription

Explore with Pulumi AI

ngrok logo
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

    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: Optional[EventSubscriptionArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def EventSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      destination_ids: Optional[Sequence[str]] = None,
                      metadata: Optional[str] = None,
                      sources: Optional[Sequence[EventSubscriptionSourceArgs]] = None)
    func NewEventSubscription(ctx *Context, name string, args *EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)
    public EventSubscription(string name, EventSubscriptionArgs? args = null, CustomResourceOptions? opts = null)
    public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)

    type: ngrok: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.

    Example

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

    var eventSubscriptionResource = new Ngrok.EventSubscription("eventSubscriptionResource", new()
{
    Description = "string",
    DestinationIds = new[]
    {
        "string",
    },
    Metadata = "string",
    Sources = new[]
    {
        new Ngrok.Inputs.EventSubscriptionSourceArgs
        {
            Fields = new[]
            {
                "string",
            },
            Filter = "string",
            Type = "string",
            Uri = "string",
        },
    },
});

    example, err := ngrok.NewEventSubscription(ctx, "eventSubscriptionResource", &ngrok.EventSubscriptionArgs{
	Description: pulumi.String("string"),
	DestinationIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Metadata: pulumi.String("string"),
	Sources: ngrok.EventSubscriptionSourceArray{
		&ngrok.EventSubscriptionSourceArgs{
			Fields: pulumi.StringArray{
				pulumi.String("string"),
			},
			Filter: pulumi.String("string"),
			Type:   pulumi.String("string"),
			Uri:    pulumi.String("string"),
		},
	},
})

    var eventSubscriptionResource = new EventSubscription("eventSubscriptionResource", EventSubscriptionArgs.builder()        
    .description("string")
    .destinationIds("string")
    .metadata("string")
    .sources(EventSubscriptionSourceArgs.builder()
        .fields("string")
        .filter("string")
        .type("string")
        .uri("string")
        .build())
    .build());

    event_subscription_resource = ngrok.EventSubscription("eventSubscriptionResource",
    description="string",
    destination_ids=["string"],
    metadata="string",
    sources=[ngrok.EventSubscriptionSourceArgs(
        fields=["string"],
        filter="string",
        type="string",
        uri="string",
    )])

    const eventSubscriptionResource = new ngrok.EventSubscription("eventSubscriptionResource", {
    description: "string",
    destinationIds: ["string"],
    metadata: "string",
    sources: [{
        fields: ["string"],
        filter: "string",
        type: "string",
        uri: "string",
    }],
});

    type: ngrok:EventSubscription
properties:
    description: string
    destinationIds:
        - string
    metadata: string
    sources:
        - fields:
            - string
          filter: string
          type: string
          uri: 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

    The EventSubscription resource accepts the following input properties:

    Description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    DestinationIds List<string>
    A list of Event Destination IDs which should be used for this Event Subscription.
    Metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    Sources List<PiersKarsenbarg.Ngrok.Inputs.EventSubscriptionSource>
    Sources containing the types for which this event subscription will trigger
    Description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    DestinationIds []string
    A list of Event Destination IDs which should be used for this Event Subscription.
    Metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    Sources []EventSubscriptionSourceArgs
    Sources containing the types for which this event subscription will trigger
    description String
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds List<String>
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata String
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources List<EventSubscriptionSource>
    Sources containing the types for which this event subscription will trigger
    description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds string[]
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources EventSubscriptionSource[]
    Sources containing the types for which this event subscription will trigger
    description str
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destination_ids Sequence[str]
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata str
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources Sequence[EventSubscriptionSourceArgs]
    Sources containing the types for which this event subscription will trigger
    description String
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds List<String>
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata String
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources List<Property Map>
    Sources containing the types for which this event subscription will trigger

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EventSubscription Resource

    Get an existing EventSubscription 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?: EventSubscriptionState, opts?: CustomResourceOptions): EventSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        destination_ids: Optional[Sequence[str]] = None,
        metadata: Optional[str] = None,
        sources: Optional[Sequence[EventSubscriptionSourceArgs]] = None) -> EventSubscription
    func GetEventSubscription(ctx *Context, name string, id IDInput, state *EventSubscriptionState, opts ...ResourceOption) (*EventSubscription, error)
    public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState? state, CustomResourceOptions? opts = null)
    public static EventSubscription get(String name, Output<String> id, EventSubscriptionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    DestinationIds List<string>
    A list of Event Destination IDs which should be used for this Event Subscription.
    Metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    Sources List<PiersKarsenbarg.Ngrok.Inputs.EventSubscriptionSource>
    Sources containing the types for which this event subscription will trigger
    Description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    DestinationIds []string
    A list of Event Destination IDs which should be used for this Event Subscription.
    Metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    Sources []EventSubscriptionSourceArgs
    Sources containing the types for which this event subscription will trigger
    description String
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds List<String>
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata String
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources List<EventSubscriptionSource>
    Sources containing the types for which this event subscription will trigger
    description string
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds string[]
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata string
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources EventSubscriptionSource[]
    Sources containing the types for which this event subscription will trigger
    description str
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destination_ids Sequence[str]
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata str
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources Sequence[EventSubscriptionSourceArgs]
    Sources containing the types for which this event subscription will trigger
    description String
    Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
    destinationIds List<String>
    A list of Event Destination IDs which should be used for this Event Subscription.
    metadata String
    Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
    sources List<Property Map>
    Sources containing the types for which this event subscription will trigger

    Supporting Types

    EventSubscriptionSource, EventSubscriptionSourceArgs

    Fields List<string>
    TODO
    Filter string
    TODO
    Type string
    Type of event for which an event subscription will trigger
    Uri string
    URI of the Event Source API resource.
    Fields []string
    TODO
    Filter string
    TODO
    Type string
    Type of event for which an event subscription will trigger
    Uri string
    URI of the Event Source API resource.
    fields List<String>
    TODO
    filter String
    TODO
    type String
    Type of event for which an event subscription will trigger
    uri String
    URI of the Event Source API resource.
    fields string[]
    TODO
    filter string
    TODO
    type string
    Type of event for which an event subscription will trigger
    uri string
    URI of the Event Source API resource.
    fields Sequence[str]
    TODO
    filter str
    TODO
    type str
    Type of event for which an event subscription will trigger
    uri str
    URI of the Event Source API resource.
    fields List<String>
    TODO
    filter String
    TODO
    type String
    Type of event for which an event subscription will trigger
    uri String
    URI of the Event Source API resource.

    Package Details

    Repository
    ngrok pierskarsenbarg/pulumi-ngrok
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ngrok Terraform Provider.
    ngrok logo
    ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
    pierskarsenbarg/pulumi-ngrok