ngrok v0.0.21, Jun 1 23

ngrok.EventDestination

Explore with Pulumi AI

Example Usage

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ngrok.EventDestination;
import com.pulumi.ngrok.EventDestinationArgs;
import com.pulumi.ngrok.inputs.EventDestinationTargetArgs;
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 example = new EventDestination("example", EventDestinationArgs.builder()        
            .description("kinesis dev stream")
            .format("json")
            .metadata("{\"environment\":\"dev\"}")
            .targets(EventDestinationTargetArgs.builder()
                .kineses(EventDestinationTargetKineseArgs.builder()
                    .auth(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .streamArn("arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2")
                    .build())
                .build())
            .build());

    }
}

Coming soon!

resources:
  example:
    type: ngrok:EventDestination
    properties:
      description: kinesis dev stream
      format: json
      metadata: '{"environment":"dev"}'
      targets:
        - kineses:
            - auth:
                - role:
                    - roleArn: arn:aws:iam::123456789012:role/example
              streamArn: arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2

Create EventDestination Resource

new EventDestination(name: string, args?: EventDestinationArgs, opts?: CustomResourceOptions);

@overload
def EventDestination(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     format: Optional[str] = None,
                     metadata: Optional[str] = None,
                     targets: Optional[Sequence[EventDestinationTargetArgs]] = None,
                     verify_with_test_event: Optional[bool] = None)
@overload
def EventDestination(resource_name: str,
                     args: Optional[EventDestinationArgs] = None,
                     opts: Optional[ResourceOptions] = None)

func NewEventDestination(ctx *Context, name string, args *EventDestinationArgs, opts ...ResourceOption) (*EventDestination, error)

public EventDestination(string name, EventDestinationArgs? args = null, CustomResourceOptions? opts = null)

public EventDestination(String name, EventDestinationArgs args)
public EventDestination(String name, EventDestinationArgs args, CustomResourceOptions options)

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

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

name string: The unique name of the resource.
args EventDestinationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EventDestinationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Description string: Human-readable description of the Event Destination. Optional, max 255 bytes.
Format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
Metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Targets List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetArgs>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
VerifyWithTestEvent bool

Description string: Human-readable description of the Event Destination. Optional, max 255 bytes.
Format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
Metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Targets []EventDestinationTargetArgs: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
VerifyWithTestEvent bool

description String: Human-readable description of the Event Destination. Optional, max 255 bytes.
format String: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata String: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets List<EventDestinationTargetArgs>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent Boolean

description string: Human-readable description of the Event Destination. Optional, max 255 bytes.
format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets EventDestinationTargetArgs[]: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent boolean

description str: Human-readable description of the Event Destination. Optional, max 255 bytes.
format str: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata str: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets Sequence[EventDestinationTargetArgs]: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verify_with_test_event bool

description String: Human-readable description of the Event Destination. Optional, max 255 bytes.
format String: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata String: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets List<Property Map>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent Boolean

Outputs

All input properties are implicitly available as output properties. Additionally, the EventDestination 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 EventDestination Resource

Get an existing EventDestination 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?: EventDestinationState, opts?: CustomResourceOptions): EventDestination

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        format: Optional[str] = None,
        metadata: Optional[str] = None,
        targets: Optional[Sequence[EventDestinationTargetArgs]] = None,
        verify_with_test_event: Optional[bool] = None) -> EventDestination

func GetEventDestination(ctx *Context, name string, id IDInput, state *EventDestinationState, opts ...ResourceOption) (*EventDestination, error)

public static EventDestination Get(string name, Input<string> id, EventDestinationState? state, CustomResourceOptions? opts = null)

public static EventDestination get(String name, Output<String> id, EventDestinationState 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: Human-readable description of the Event Destination. Optional, max 255 bytes.
Format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
Metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Targets List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetArgs>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
VerifyWithTestEvent bool

Description string: Human-readable description of the Event Destination. Optional, max 255 bytes.
Format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
Metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Targets []EventDestinationTargetArgs: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
VerifyWithTestEvent bool

description String: Human-readable description of the Event Destination. Optional, max 255 bytes.
format String: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata String: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets List<EventDestinationTargetArgs>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent Boolean

description string: Human-readable description of the Event Destination. Optional, max 255 bytes.
format string: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata string: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets EventDestinationTargetArgs[]: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent boolean

description str: Human-readable description of the Event Destination. Optional, max 255 bytes.
format str: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata str: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets Sequence[EventDestinationTargetArgs]: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verify_with_test_event bool

description String: Human-readable description of the Event Destination. Optional, max 255 bytes.
format String: The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
metadata String: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
targets List<Property Map>: An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
verifyWithTestEvent Boolean

Supporting Types

EventDestinationTarget

CloudwatchLogs List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetCloudwatchLog>: Configuration used to send events to Amazon CloudWatch Logs.
Debugs List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetDebug>: Configuration used for internal debugging.
Firehoses List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetFirehose>: Configuration used to send events to Amazon Kinesis Data Firehose.
Kineses List<PiersKarsenbarg.Ngrok.Inputs.EventDestinationTargetKinese>: Configuration used to send events to Amazon Kinesis.

CloudwatchLogs []EventDestinationTargetCloudwatchLog: Configuration used to send events to Amazon CloudWatch Logs.
Debugs []EventDestinationTargetDebug: Configuration used for internal debugging.
Firehoses []EventDestinationTargetFirehose: Configuration used to send events to Amazon Kinesis Data Firehose.
Kineses []EventDestinationTargetKinese: Configuration used to send events to Amazon Kinesis.

cloudwatchLogs List<EventDestinationTargetCloudwatchLog>: Configuration used to send events to Amazon CloudWatch Logs.
debugs List<EventDestinationTargetDebug>: Configuration used for internal debugging.
firehoses List<EventDestinationTargetFirehose>: Configuration used to send events to Amazon Kinesis Data Firehose.
kineses List<EventDestinationTargetKinese>: Configuration used to send events to Amazon Kinesis.

cloudwatchLogs EventDestinationTargetCloudwatchLog[]: Configuration used to send events to Amazon CloudWatch Logs.
debugs EventDestinationTargetDebug[]: Configuration used for internal debugging.
firehoses EventDestinationTargetFirehose[]: Configuration used to send events to Amazon Kinesis Data Firehose.
kineses EventDestinationTargetKinese[]: Configuration used to send events to Amazon Kinesis.

cloudwatch_logs Sequence[EventDestinationTargetCloudwatchLog]: Configuration used to send events to Amazon CloudWatch Logs.
debugs Sequence[EventDestinationTargetDebug]: Configuration used for internal debugging.
firehoses Sequence[EventDestinationTargetFirehose]: Configuration used to send events to Amazon Kinesis Data Firehose.
kineses Sequence[EventDestinationTargetKinese]: Configuration used to send events to Amazon Kinesis.

cloudwatchLogs List<Property Map>: Configuration used to send events to Amazon CloudWatch Logs.
debugs List<Property Map>: Configuration used for internal debugging.
firehoses List<Property Map>: Configuration used to send events to Amazon Kinesis Data Firehose.
kineses List<Property Map>: Configuration used to send events to Amazon Kinesis.