Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. opsgenie
  5. Integration
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.opsgenie.Integration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

    Splunk Observability Cloud Opsgenie integration.

    NOTE When managing integrations, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator. Otherwise you’ll receive a 4xx error.

    Example

    resource "signalfx_opsgenie_integration" "opgenie_myteam" {
  name    = "Opsgenie - My Team"
  enabled = true
  api_key = "my-key"
  api_url = "https://api.opsgenie.com"
}

    Create Integration Resource

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

    Constructor syntax

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

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                api_key: Optional[str] = None,
                enabled: Optional[bool] = None,
                api_url: Optional[str] = None,
                name: Optional[str] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: signalfx:opsgenie:Integration
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 IntegrationArgs
    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 IntegrationArgs
    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 IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    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 exampleintegrationResourceResourceFromOpsgenieintegration = new SignalFx.Opsgenie.Integration("exampleintegrationResourceResourceFromOpsgenieintegration", new()
{
    ApiKey = "string",
    Enabled = false,
    ApiUrl = "string",
    Name = "string",
});

    example, err := opsgenie.NewIntegration(ctx, "exampleintegrationResourceResourceFromOpsgenieintegration", &opsgenie.IntegrationArgs{
	ApiKey:  pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	ApiUrl:  pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    var exampleintegrationResourceResourceFromOpsgenieintegration = new Integration("exampleintegrationResourceResourceFromOpsgenieintegration", IntegrationArgs.builder()
    .apiKey("string")
    .enabled(false)
    .apiUrl("string")
    .name("string")
    .build());

    exampleintegration_resource_resource_from_opsgenieintegration = signalfx.opsgenie.Integration("exampleintegrationResourceResourceFromOpsgenieintegration",
    api_key="string",
    enabled=False,
    api_url="string",
    name="string")

    const exampleintegrationResourceResourceFromOpsgenieintegration = new signalfx.opsgenie.Integration("exampleintegrationResourceResourceFromOpsgenieintegration", {
    apiKey: "string",
    enabled: false,
    apiUrl: "string",
    name: "string",
});

    type: signalfx:opsgenie:Integration
properties:
    apiKey: string
    apiUrl: string
    enabled: false
    name: string

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

    ApiKey string
    The API key
    Enabled bool
    Whether the integration is enabled.
    ApiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    Name string
    Name of the integration.
    ApiKey string
    The API key
    Enabled bool
    Whether the integration is enabled.
    ApiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    Name string
    Name of the integration.
    apiKey String
    The API key
    enabled Boolean
    Whether the integration is enabled.
    apiUrl String
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    name String
    Name of the integration.
    apiKey string
    The API key
    enabled boolean
    Whether the integration is enabled.
    apiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    name string
    Name of the integration.
    api_key str
    The API key
    enabled bool
    Whether the integration is enabled.
    api_url str
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    name str
    Name of the integration.
    apiKey String
    The API key
    enabled Boolean
    Whether the integration is enabled.
    apiUrl String
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    name String
    Name of the integration.

    Outputs

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

    Get an existing Integration 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?: IntegrationState, opts?: CustomResourceOptions): Integration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        api_url: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None) -> Integration
    func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
    public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
    public static Integration get(String name, Output<String> id, IntegrationState 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:
    ApiKey string
    The API key
    ApiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    Enabled bool
    Whether the integration is enabled.
    Name string
    Name of the integration.
    ApiKey string
    The API key
    ApiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    Enabled bool
    Whether the integration is enabled.
    Name string
    Name of the integration.
    apiKey String
    The API key
    apiUrl String
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    enabled Boolean
    Whether the integration is enabled.
    name String
    Name of the integration.
    apiKey string
    The API key
    apiUrl string
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    enabled boolean
    Whether the integration is enabled.
    name string
    Name of the integration.
    api_key str
    The API key
    api_url str
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    enabled bool
    Whether the integration is enabled.
    name str
    Name of the integration.
    apiKey String
    The API key
    apiUrl String
    Opsgenie API URL. Will default to https://api.opsgenie.com. You might also want https://api.eu.opsgenie.com.
    enabled Boolean
    Whether the integration is enabled.
    name String
    Name of the integration.

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-signalfx