alertchannel

package
v7.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 13, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

newrelic_alert_channel

Refer to the Terraform Registory for docs: newrelic_alert_channel.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AlertChannel_IsConstruct 

func AlertChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func AlertChannel_IsTerraformElement 

func AlertChannel_IsTerraformElement(x interface{}) *bool

Experimental.

func AlertChannel_IsTerraformResource 

func AlertChannel_IsTerraformResource(x interface{}) *bool

Experimental.

func AlertChannel_TfResourceType 

func AlertChannel_TfResourceType() *string

func NewAlertChannelConfigAOutputReference_Override 

func NewAlertChannelConfigAOutputReference_Override(a AlertChannelConfigAOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewAlertChannel_Override 

func NewAlertChannel_Override(a AlertChannel, scope constructs.Construct, id *string, config *AlertChannelConfig)

Create a new {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel newrelic_alert_channel} Resource.

Types

type AlertChannel 

type AlertChannel interface {
	cdktf.TerraformResource
	AccountId() *float64
	SetAccountId(val *float64)
	AccountIdInput() *float64
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Config() AlertChannelConfigAOutputReference
	ConfigInput() *AlertChannelConfigA
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutConfig(value *AlertChannelConfigA)
	ResetAccountId()
	ResetConfig()
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel newrelic_alert_channel}.

func NewAlertChannel 

func NewAlertChannel(scope constructs.Construct, id *string, config *AlertChannelConfig) AlertChannel

Create a new {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel newrelic_alert_channel} Resource.

type AlertChannelConfig 

type AlertChannelConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// (Required) The name of the channel.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#name AlertChannel#name}
	Name *string `field:"required" json:"name" yaml:"name"`
	// (Required) The type of channel. One of: (slack, user, victorops, webhook, email, opsgenie, pagerduty).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#type AlertChannel#type}
	Type *string `field:"required" json:"type" yaml:"type"`
	// The New Relic account ID where you want to create alert channels.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#account_id AlertChannel#account_id}
	AccountId *float64 `field:"optional" json:"accountId" yaml:"accountId"`
	// config block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#config AlertChannel#config}
	Config *AlertChannelConfigA `field:"optional" json:"config" yaml:"config"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#id AlertChannel#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
}

type AlertChannelConfigA 

type AlertChannelConfigA struct {
	// The API key for integrating with OpsGenie.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#api_key AlertChannel#api_key}
	ApiKey *string `field:"optional" json:"apiKey" yaml:"apiKey"`
	// Specifies an authentication password for use with a channel. Supported by the webhook channel type.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#auth_password AlertChannel#auth_password}
	AuthPassword *string `field:"optional" json:"authPassword" yaml:"authPassword"`
	// Specifies an authentication method for use with a channel.
	//
	// Supported by the webhook channel type. Only HTTP basic authentication is currently supported via the value BASIC.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#auth_type AlertChannel#auth_type}
	AuthType *string `field:"optional" json:"authType" yaml:"authType"`
	// Specifies an authentication username for use with a channel. Supported by the webhook channel type.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#auth_username AlertChannel#auth_username}
	AuthUsername *string `field:"optional" json:"authUsername" yaml:"authUsername"`
	// The base URL of the webhook destination.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#base_url AlertChannel#base_url}
	BaseUrl *string `field:"optional" json:"baseUrl" yaml:"baseUrl"`
	// The Slack channel to send notifications to.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#channel AlertChannel#channel}
	Channel *string `field:"optional" json:"channel" yaml:"channel"`
	// A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#headers AlertChannel#headers}
	Headers *map[string]*string `field:"optional" json:"headers" yaml:"headers"`
	// Use instead of headers if the desired payload is more complex than a list of key/value pairs (e.g. a set of headers that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with headers.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#headers_string AlertChannel#headers_string}
	HeadersString *string `field:"optional" json:"headersString" yaml:"headersString"`
	// true or false.
	//
	// Flag for whether or not to attach a JSON document containing information about the associated alert to the email that is sent to recipients.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#include_json_attachment AlertChannel#include_json_attachment}
	IncludeJsonAttachment *string `field:"optional" json:"includeJsonAttachment" yaml:"includeJsonAttachment"`
	// The key for integrating with VictorOps.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#key AlertChannel#key}
	Key *string `field:"optional" json:"key" yaml:"key"`
	// A map of key/value pairs that represents the webhook payload. Must provide payload_type if setting this argument.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#payload AlertChannel#payload}
	Payload *map[string]*string `field:"optional" json:"payload" yaml:"payload"`
	// Use instead of payload if the desired payload is more complex than a list of key/value pairs (e.g. a payload that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with payload.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#payload_string AlertChannel#payload_string}
	PayloadString *string `field:"optional" json:"payloadString" yaml:"payloadString"`
	// Can either be application/json or application/x-www-form-urlencoded. The payload_type argument is required if payload is set.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#payload_type AlertChannel#payload_type}
	PayloadType *string `field:"optional" json:"payloadType" yaml:"payloadType"`
	// A set of recipients for targeting notifications. Multiple values are comma separated.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#recipients AlertChannel#recipients}
	Recipients *string `field:"optional" json:"recipients" yaml:"recipients"`
	// The data center region to store your data. Valid values are US and EU. Default is US.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#region AlertChannel#region}
	Region *string `field:"optional" json:"region" yaml:"region"`
	// The route key for integrating with VictorOps.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#route_key AlertChannel#route_key}
	RouteKey *string `field:"optional" json:"routeKey" yaml:"routeKey"`
	// Specifies the service key for integrating with Pagerduty.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#service_key AlertChannel#service_key}
	ServiceKey *string `field:"optional" json:"serviceKey" yaml:"serviceKey"`
	// A set of tags for targeting notifications. Multiple values are comma separated.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#tags AlertChannel#tags}
	Tags *string `field:"optional" json:"tags" yaml:"tags"`
	// A set of teams for targeting notifications. Multiple values are comma separated.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#teams AlertChannel#teams}
	Teams *string `field:"optional" json:"teams" yaml:"teams"`
	// Your organization's Slack URL.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#url AlertChannel#url}
	Url *string `field:"optional" json:"url" yaml:"url"`
	// The user ID for use with the user channel type.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.24.2/docs/resources/alert_channel#user_id AlertChannel#user_id}
	UserId *string `field:"optional" json:"userId" yaml:"userId"`
}

type AlertChannelConfigAOutputReference 

type AlertChannelConfigAOutputReference interface {
	cdktf.ComplexObject
	ApiKey() *string
	SetApiKey(val *string)
	ApiKeyInput() *string
	AuthPassword() *string
	SetAuthPassword(val *string)
	AuthPasswordInput() *string
	AuthType() *string
	SetAuthType(val *string)
	AuthTypeInput() *string
	AuthUsername() *string
	SetAuthUsername(val *string)
	AuthUsernameInput() *string
	BaseUrl() *string
	SetBaseUrl(val *string)
	BaseUrlInput() *string
	Channel() *string
	SetChannel(val *string)
	ChannelInput() *string
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	Headers() *map[string]*string
	SetHeaders(val *map[string]*string)
	HeadersInput() *map[string]*string
	HeadersString() *string
	SetHeadersString(val *string)
	HeadersStringInput() *string
	IncludeJsonAttachment() *string
	SetIncludeJsonAttachment(val *string)
	IncludeJsonAttachmentInput() *string
	InternalValue() *AlertChannelConfigA
	SetInternalValue(val *AlertChannelConfigA)
	Key() *string
	SetKey(val *string)
	KeyInput() *string
	Payload() *map[string]*string
	SetPayload(val *map[string]*string)
	PayloadInput() *map[string]*string
	PayloadString() *string
	SetPayloadString(val *string)
	PayloadStringInput() *string
	PayloadType() *string
	SetPayloadType(val *string)
	PayloadTypeInput() *string
	Recipients() *string
	SetRecipients(val *string)
	RecipientsInput() *string
	Region() *string
	SetRegion(val *string)
	RegionInput() *string
	RouteKey() *string
	SetRouteKey(val *string)
	RouteKeyInput() *string
	ServiceKey() *string
	SetServiceKey(val *string)
	ServiceKeyInput() *string
	Tags() *string
	SetTags(val *string)
	TagsInput() *string
	Teams() *string
	SetTeams(val *string)
	TeamsInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Url() *string
	SetUrl(val *string)
	UrlInput() *string
	UserId() *string
	SetUserId(val *string)
	UserIdInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetApiKey()
	ResetAuthPassword()
	ResetAuthType()
	ResetAuthUsername()
	ResetBaseUrl()
	ResetChannel()
	ResetHeaders()
	ResetHeadersString()
	ResetIncludeJsonAttachment()
	ResetKey()
	ResetPayload()
	ResetPayloadString()
	ResetPayloadType()
	ResetRecipients()
	ResetRegion()
	ResetRouteKey()
	ResetServiceKey()
	ResetTags()
	ResetTeams()
	ResetUrl()
	ResetUserId()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewAlertChannelConfigAOutputReference 

func NewAlertChannelConfigAOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) AlertChannelConfigAOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.