OrgToken
Manage SignalFx org tokens.
Example Usage
using Pulumi;
using SignalFx = Pulumi.SignalFx;
class MyStack : Stack
{
public MyStack()
{
var myteamkey0 = new SignalFx.OrgToken("myteamkey0", new SignalFx.OrgTokenArgs
{
Description = "My team's rad key",
HostOrUsageLimits = new SignalFx.Inputs.OrgTokenHostOrUsageLimitsArgs
{
ContainerLimit = 200,
ContainerNotificationThreshold = 180,
CustomMetricsLimit = 1000,
CustomMetricsNotificationThreshold = 900,
HighResMetricsLimit = 1000,
HighResMetricsNotificationThreshold = 900,
HostLimit = 100,
HostNotificationThreshold = 90,
},
Notifications =
{
"Email,foo-alerts@bar.com",
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v4/go/signalfx"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewOrgToken(ctx, "myteamkey0", &signalfx.OrgTokenArgs{
Description: pulumi.String("My team's rad key"),
HostOrUsageLimits: &signalfx.OrgTokenHostOrUsageLimitsArgs{
ContainerLimit: pulumi.Int(200),
ContainerNotificationThreshold: pulumi.Int(180),
CustomMetricsLimit: pulumi.Int(1000),
CustomMetricsNotificationThreshold: pulumi.Int(900),
HighResMetricsLimit: pulumi.Int(1000),
HighResMetricsNotificationThreshold: pulumi.Int(900),
HostLimit: pulumi.Int(100),
HostNotificationThreshold: pulumi.Int(90),
},
Notifications: pulumi.StringArray{
pulumi.String("Email,foo-alerts@bar.com"),
},
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_signalfx as signalfx
myteamkey0 = signalfx.OrgToken("myteamkey0",
description="My team's rad key",
host_or_usage_limits=signalfx.OrgTokenHostOrUsageLimitsArgs(
container_limit=200,
container_notification_threshold=180,
custom_metrics_limit=1000,
custom_metrics_notification_threshold=900,
high_res_metrics_limit=1000,
high_res_metrics_notification_threshold=900,
host_limit=100,
host_notification_threshold=90,
),
notifications=["Email,foo-alerts@bar.com"])
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const myteamkey0 = new signalfx.OrgToken("myteamkey0", {
description: "My team's rad key",
hostOrUsageLimits: {
containerLimit: 200,
containerNotificationThreshold: 180,
customMetricsLimit: 1000,
customMetricsNotificationThreshold: 900,
highResMetricsLimit: 1000,
highResMetricsNotificationThreshold: 900,
hostLimit: 100,
hostNotificationThreshold: 90,
},
notifications: ["Email,foo-alerts@bar.com"],
});
Create a OrgToken Resource
new OrgToken(name: string, args?: OrgTokenArgs, opts?: CustomResourceOptions);
def OrgToken(resource_name: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, disabled: Optional[bool] = None, dpm_limits: Optional[OrgTokenDpmLimitsArgs] = None, host_or_usage_limits: Optional[OrgTokenHostOrUsageLimitsArgs] = None, name: Optional[str] = None, notifications: Optional[Sequence[str]] = None)
func NewOrgToken(ctx *Context, name string, args *OrgTokenArgs, opts ...ResourceOption) (*OrgToken, error)
public OrgToken(string name, OrgTokenArgs? args = null, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args OrgTokenArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrgTokenArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrgTokenArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
OrgToken Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The OrgToken resource accepts the following input properties:
- Description string
Description of the token.
- Disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- Dpm
Limits Pulumi.Signal Fx. Inputs. Org Token Dpm Limits Args Specify DPM-based limits for this token.
- Host
Or Pulumi.Usage Limits Signal Fx. Inputs. Org Token Host Or Usage Limits Args Specify Usage-based limits for this token.
- Name string
Name of the token.
- Notifications List<string>
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- Description string
Description of the token.
- Disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- Dpm
Limits OrgToken Dpm Limits Specify DPM-based limits for this token.
- Host
Or OrgUsage Limits Token Host Or Usage Limits Specify Usage-based limits for this token.
- Name string
Name of the token.
- Notifications []string
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- description string
Description of the token.
- disabled boolean
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- dpm
Limits OrgToken Dpm Limits Specify DPM-based limits for this token.
- host
Or OrgUsage Limits Token Host Or Usage Limits Specify Usage-based limits for this token.
- name string
Name of the token.
- notifications string[]
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- description str
Description of the token.
- disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- dpm_
limits OrgToken Dpm Limits Args Specify DPM-based limits for this token.
- host_
or_ Orgusage_ limits Token Host Or Usage Limits Args Specify Usage-based limits for this token.
- name str
Name of the token.
- notifications Sequence[str]
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
Outputs
All input properties are implicitly available as output properties. Additionally, the OrgToken resource produces the following output properties:
Look up an Existing OrgToken Resource
Get an existing OrgToken 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?: OrgTokenState, opts?: CustomResourceOptions): OrgToken
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, disabled: Optional[bool] = None, dpm_limits: Optional[OrgTokenDpmLimitsArgs] = None, host_or_usage_limits: Optional[OrgTokenHostOrUsageLimitsArgs] = None, name: Optional[str] = None, notifications: Optional[Sequence[str]] = None, secret: Optional[str] = None) -> OrgToken
func GetOrgToken(ctx *Context, name string, id IDInput, state *OrgTokenState, opts ...ResourceOption) (*OrgToken, error)
public static OrgToken Get(string name, Input<string> id, OrgTokenState? state, CustomResourceOptions? opts = null)
- 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.
The following state arguments are supported:
- Description string
Description of the token.
- Disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- Dpm
Limits Pulumi.Signal Fx. Inputs. Org Token Dpm Limits Args Specify DPM-based limits for this token.
- Host
Or Pulumi.Usage Limits Signal Fx. Inputs. Org Token Host Or Usage Limits Args Specify Usage-based limits for this token.
- Name string
Name of the token.
- Notifications List<string>
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- Secret string
The secret token created by the API. You cannot set this value.
- Description string
Description of the token.
- Disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- Dpm
Limits OrgToken Dpm Limits Specify DPM-based limits for this token.
- Host
Or OrgUsage Limits Token Host Or Usage Limits Specify Usage-based limits for this token.
- Name string
Name of the token.
- Notifications []string
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- Secret string
The secret token created by the API. You cannot set this value.
- description string
Description of the token.
- disabled boolean
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- dpm
Limits OrgToken Dpm Limits Specify DPM-based limits for this token.
- host
Or OrgUsage Limits Token Host Or Usage Limits Specify Usage-based limits for this token.
- name string
Name of the token.
- notifications string[]
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- secret string
The secret token created by the API. You cannot set this value.
- description str
Description of the token.
- disabled bool
Flag that controls enabling the token. If set to
true
, the token is disabled, and you can’t use it for authentication. Defaults tofalse
.- dpm_
limits OrgToken Dpm Limits Args Specify DPM-based limits for this token.
- host_
or_ Orgusage_ limits Token Host Or Usage Limits Args Specify Usage-based limits for this token.
- name str
Name of the token.
- notifications Sequence[str]
List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
- secret str
The secret token created by the API. You cannot set this value.
Supporting Types
OrgTokenDpmLimits
- Dpm
Limit int The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert.
- Dpm
Notification intThreshold DPM level at which SignalFx sends the notification for this token. If you don’t specify a notification, SignalFx sends the generic notification.
- Dpm
Limit int The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert.
- Dpm
Notification intThreshold DPM level at which SignalFx sends the notification for this token. If you don’t specify a notification, SignalFx sends the generic notification.
- dpm
Limit number The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert.
- dpm
Notification numberThreshold DPM level at which SignalFx sends the notification for this token. If you don’t specify a notification, SignalFx sends the generic notification.
- dpm_
limit int The datapoints per minute (dpm) limit for this token. If you exceed this limit, SignalFx sends out an alert.
- dpm_
notification_ intthreshold DPM level at which SignalFx sends the notification for this token. If you don’t specify a notification, SignalFx sends the generic notification.
OrgTokenHostOrUsageLimits
- Container
Limit int Max number of Docker containers that can use this token
- Container
Notification intThreshold Notification threshold for Docker containers
- Custom
Metrics intLimit Max number of custom metrics that can be sent with this token
- Custom
Metrics intNotification Threshold Notification threshold for custom metrics
- High
Res intMetrics Limit Max number of hi-res metrics that can be sent with this toke
- High
Res intMetrics Notification Threshold Notification threshold for hi-res metrics
- Host
Limit int Max number of hosts that can use this token
- Host
Notification intThreshold Notification threshold for hosts
- Container
Limit int Max number of Docker containers that can use this token
- Container
Notification intThreshold Notification threshold for Docker containers
- Custom
Metrics intLimit Max number of custom metrics that can be sent with this token
- Custom
Metrics intNotification Threshold Notification threshold for custom metrics
- High
Res intMetrics Limit Max number of hi-res metrics that can be sent with this toke
- High
Res intMetrics Notification Threshold Notification threshold for hi-res metrics
- Host
Limit int Max number of hosts that can use this token
- Host
Notification intThreshold Notification threshold for hosts
- container
Limit number Max number of Docker containers that can use this token
- container
Notification numberThreshold Notification threshold for Docker containers
- custom
Metrics numberLimit Max number of custom metrics that can be sent with this token
- custom
Metrics numberNotification Threshold Notification threshold for custom metrics
- high
Res numberMetrics Limit Max number of hi-res metrics that can be sent with this toke
- high
Res numberMetrics Notification Threshold Notification threshold for hi-res metrics
- host
Limit number Max number of hosts that can use this token
- host
Notification numberThreshold Notification threshold for hosts
- container_
limit int Max number of Docker containers that can use this token
- container_
notification_ intthreshold Notification threshold for Docker containers
- custom_
metrics_ intlimit Max number of custom metrics that can be sent with this token
- custom_
metrics_ intnotification_ threshold Notification threshold for custom metrics
- high_
res_ intmetrics_ limit Max number of hi-res metrics that can be sent with this toke
- high_
res_ intmetrics_ notification_ threshold Notification threshold for hi-res metrics
- host_
limit int Max number of hosts that can use this token
- host_
notification_ intthreshold Notification threshold for hosts
Package Details
- Repository
- https://github.com/pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.