Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Spotinst Provider
  3. API Docs
  4. Subscription
Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-spotinst

spotinst.Subscription

Explore with Pulumi AI

spotinst logo
Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-spotinst

    Provides a Spotinst subscription resource.

    Example Usage

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

// Create a Subscription
const default_subscription = new spotinst.Subscription("default-subscription", {
    resourceId: my_eg.id,
    eventType: "AWS_EC2_INSTANCE_LAUNCH",
    protocol: "http",
    endpoint: "http://endpoint.com",
    format: {
        event: "%event%",
        instance_id: "%instance-id%",
        resource_id: "%resource-id%",
        resource_name: "%resource-name%",
        tags: "foo,baz,baz",
    },
});

    import pulumi
import pulumi_spotinst as spotinst

# Create a Subscription
default_subscription = spotinst.Subscription("default-subscription",
    resource_id=my_eg["id"],
    event_type="AWS_EC2_INSTANCE_LAUNCH",
    protocol="http",
    endpoint="http://endpoint.com",
    format={
        "event": "%event%",
        "instance_id": "%instance-id%",
        "resource_id": "%resource-id%",
        "resource_name": "%resource-name%",
        "tags": "foo,baz,baz",
    })

    package main

import (
	"github.com/pulumi/pulumi-spotinst/sdk/v3/go/spotinst"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a Subscription
		_, err := spotinst.NewSubscription(ctx, "default-subscription", &spotinst.SubscriptionArgs{
			ResourceId: pulumi.Any(my_eg.Id),
			EventType:  pulumi.String("AWS_EC2_INSTANCE_LAUNCH"),
			Protocol:   pulumi.String("http"),
			Endpoint:   pulumi.String("http://endpoint.com"),
			Format: pulumi.StringMap{
				"event":         pulumi.String("%event%"),
				"instance_id":   pulumi.String("%instance-id%"),
				"resource_id":   pulumi.String("%resource-id%"),
				"resource_name": pulumi.String("%resource-name%"),
				"tags":          pulumi.String("foo,baz,baz"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a Subscription
    var default_subscription = new SpotInst.Subscription("default-subscription", new()
    {
        ResourceId = my_eg.Id,
        EventType = "AWS_EC2_INSTANCE_LAUNCH",
        Protocol = "http",
        Endpoint = "http://endpoint.com",
        Format = 
        {
            { "event", "%event%" },
            { "instance_id", "%instance-id%" },
            { "resource_id", "%resource-id%" },
            { "resource_name", "%resource-name%" },
            { "tags", "foo,baz,baz" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spotinst.Subscription;
import com.pulumi.spotinst.SubscriptionArgs;
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) {
        // Create a Subscription
        var default_subscription = new Subscription("default-subscription", SubscriptionArgs.builder()
            .resourceId(my_eg.id())
            .eventType("AWS_EC2_INSTANCE_LAUNCH")
            .protocol("http")
            .endpoint("http://endpoint.com")
            .format(Map.ofEntries(
                Map.entry("event", "%event%"),
                Map.entry("instance_id", "%instance-id%"),
                Map.entry("resource_id", "%resource-id%"),
                Map.entry("resource_name", "%resource-name%"),
                Map.entry("tags", "foo,baz,baz")
            ))
            .build());

    }
}

    resources:
  # Create a Subscription
  default-subscription:
    type: spotinst:Subscription
    properties:
      resourceId: ${["my-eg"].id}
      eventType: AWS_EC2_INSTANCE_LAUNCH
      protocol: http
      endpoint: http://endpoint.com
      format:
        event: '%event%'
        instance_id: '%instance-id%'
        resource_id: '%resource-id%'
        resource_name: '%resource-name%'
        tags: foo,baz,baz

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

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 endpoint: Optional[str] = None,
                 event_type: Optional[str] = None,
                 protocol: Optional[str] = None,
                 resource_id: Optional[str] = None,
                 format: Optional[Mapping[str, str]] = None)
    func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
    public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
    public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

    type: spotinst: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 SpotInst.Subscription("subscriptionResource", new()
{
    Endpoint = "string",
    EventType = "string",
    Protocol = "string",
    ResourceId = "string",
    Format = 
    {
        { "string", "string" },
    },
});

    example, err := spotinst.NewSubscription(ctx, "subscriptionResource", &spotinst.SubscriptionArgs{
	Endpoint:   pulumi.String("string"),
	EventType:  pulumi.String("string"),
	Protocol:   pulumi.String("string"),
	ResourceId: pulumi.String("string"),
	Format: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var subscriptionResource = new Subscription("subscriptionResource", SubscriptionArgs.builder()
    .endpoint("string")
    .eventType("string")
    .protocol("string")
    .resourceId("string")
    .format(Map.of("string", "string"))
    .build());

    subscription_resource = spotinst.Subscription("subscriptionResource",
    endpoint="string",
    event_type="string",
    protocol="string",
    resource_id="string",
    format={
        "string": "string",
    })

    const subscriptionResource = new spotinst.Subscription("subscriptionResource", {
    endpoint: "string",
    eventType: "string",
    protocol: "string",
    resourceId: "string",
    format: {
        string: "string",
    },
});

    type: spotinst:Subscription
properties:
    endpoint: string
    eventType: string
    format:
        string: string
    protocol: string
    resourceId: 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:

    Endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    EventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    Protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    ResourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    Format Dictionary<string, string>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    Endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    EventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    Protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    ResourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    Format map[string]string
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    endpoint String
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType String
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    protocol String
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId String
    Spotinst Resource id (Elastigroup or Ocean ID).
    format Map<String,String>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    format {[key: string]: string}
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    endpoint str
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    event_type str
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    protocol str
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resource_id str
    Spotinst Resource id (Elastigroup or Ocean ID).
    format Mapping[str, str]
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    endpoint String
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType String
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    protocol String
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId String
    Spotinst Resource id (Elastigroup or Ocean ID).
    format Map<String>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.

    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.
    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 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,
        endpoint: Optional[str] = None,
        event_type: Optional[str] = None,
        format: Optional[Mapping[str, str]] = None,
        protocol: Optional[str] = None,
        resource_id: Optional[str] = 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)
    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:
    Endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    EventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    Format Dictionary<string, string>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    Protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    ResourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    Endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    EventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    Format map[string]string
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    Protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    ResourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    endpoint String
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType String
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    format Map<String,String>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    protocol String
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId String
    Spotinst Resource id (Elastigroup or Ocean ID).
    endpoint string
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType string
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    format {[key: string]: string}
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    protocol string
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId string
    Spotinst Resource id (Elastigroup or Ocean ID).
    endpoint str
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    event_type str
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    format Mapping[str, str]
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    protocol str
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resource_id str
    Spotinst Resource id (Elastigroup or Ocean ID).
    endpoint String
    The endpoint the notification will be sent to. url in case of "http"/"https"/"web", email address in case of "email"/"email-json" and sns-topic-arn in case of "aws-sns".
    eventType String
    The event to send the notification when triggered. Valid values: "AWS_EC2_INSTANCE_TERMINATE", "AWS_EC2_INSTANCE_TERMINATED", "AWS_EC2_INSTANCE_LAUNCH", "AWS_EC2_INSTANCE_READY_SIGNAL_TIMEOUT", "SIGNAL_TIMEOUT_SHUTDOWN_SCRIPT", "AWS_EC2_CANT_SPIN_OD", "AWS_EC2_INSTANCE_UNHEALTHY_IN_ELB", "GROUP_ROLL_FAILED", "GROUP_ROLL_FINISHED", "CANT_SCALE_UP_GROUP_MAX_CAPACITY", "GROUP_UPDATED", "AWS_EMR_PROVISION_TIMEOUT", "GROUP_BEANSTALK_INIT_READY", "AZURE_VM_TERMINATED", "AZURE_VM_TERMINATE", "AWS_EC2_MANAGED_INSTANCE_PAUSING", "AWS_EC2_MANAGED_INSTANCE_RESUMING", "AWS_EC2_MANAGED_INSTANCE_RECYCLING","AWS_EC2_MANAGED_INSTANCE_DELETING". Ocean Events:"CLUSTER_ROLL_FINISHED","GROUP_ROLL_FAILED","OCEAN_CANT_SCALE_UP_MAX_RESOURCES" "OCEAN_LAUNCH_SPEC_CANT_SCALE_UP_MAX_INSTANCES","OCEAN_K8S_NODE_REMOVED".
    format Map<String>
    The format of the notification content (JSON Format - Key+Value). Valid Values : "instance-id", "event", "resource-id", "resource-name", "subnet-id", "availability-zone", "reason", "private-ip", "launchspec-id" Example: {"event": "event", "resourceId": "resource-id", "resourceName": "resource-name"", "myCustomKey": "My content is set here" } Default: {"event": "<event>", "instanceId": "<instance-id>", "resourceId": "<resource-id>", "resourceName": "<resource-name>" }.
    protocol String
    The protocol to send the notification. Valid values: "email", "email-json", "aws-sns", "web". The following values are deprecated: "http" , "https" You can use the generic "web" protocol instead. "aws-sns" is only supported with AWS provider
    resourceId String
    Spotinst Resource id (Elastigroup or Ocean ID).

    Package Details

    Repository
    Spotinst pulumi/pulumi-spotinst
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the spotinst Terraform Provider.
    spotinst logo
    Spotinst v3.100.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-spotinst