Skip to main content

Metadata

Resource Metadata in pulumi-better-uptime.
4 min read

Resource Metadata in pulumi-better-uptime.

Pulumi type: better-uptime:index/metadata:Metadata.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
keystringyesThe key of this Metadata.
metadataValuesMetadataMetadataValue (input)[]noAn array of typed metadata values of this Metadata. All values of one key must share the same type and must not repeat.
ownerIdstringyesThe ID of the owner of this Metadata.
ownerTypestringyesThe type of the owner of this Metadata. Valid values: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration, IncomingWebhook, AmazonSnsIntegration
teamNamestringnoUsed to specify the team the resource should be created in when using global tokens. This field is deprecated, team name doesn't have to be specified for this resource anymore. You can't update this value later.
valuestringnoThe value of this Metadata. This field is deprecated, use repeatable block metadataValue to define values with types instead.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
createdAtstringyesThe time when this metadata was created.
keystringnoThe key of this Metadata.
metadataValuesMetadataMetadataValue (output)[]noAn array of typed metadata values of this Metadata. All values of one key must share the same type and must not repeat.
ownerIdstringnoThe ID of the owner of this Metadata.
ownerTypestringnoThe type of the owner of this Metadata. Valid values: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration, IncomingWebhook, AmazonSnsIntegration
teamNamestringnoUsed to specify the team the resource should be created in when using global tokens. This field is deprecated, team name doesn't have to be specified for this resource anymore. You can't update this value later.
updatedAtstringyesThe time when this metadata was updated.
valuestringnoThe value of this Metadata. This field is deprecated, use repeatable block metadataValue to define values with types instead.

MetadataMetadataValue (input)#

Input object MetadataMetadataValue. Fields below belong to this object, not to the parent.

PropertyTypeRequiredDescription
emailstringnoEmail of the referenced user when type is User.
itemIdstringnoID of the referenced item when type is different than String.
namestringnoName of the referenced item when type is different than String. Not available for Endpoint, SlackIntegration, and ZapierWebhook, which are referenced by itemId.
typestringnoValue types can be grouped into 2 main categories: - Scalar: String - Reference: User, Team, Policy, Schedule, Endpoint, Source, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook The value of a Scalar type is defined using the value field. The value of a Reference type is defined using one of the following fields: - itemId - great choice when you know the ID of the target item. - email - your go-to choice when you're referencing users. - name - can be used to reference other items like teams, policies, etc. Not available for Endpoint, SlackIntegration, and ZapierWebhook, which are referenced by itemId. The reference types require the presence of at least one of the three fields: itemId, name, email.
valuestringnoValue when type is String.

MetadataMetadataValue (output)#

Output object MetadataMetadataValue. Fields below belong to this object.

PropertyTypeAlways presentDescription
emailstringnoEmail of the referenced user when type is User.
itemIdstringnoID of the referenced item when type is different than String.
namestringnoName of the referenced item when type is different than String. Not available for Endpoint, SlackIntegration, and ZapierWebhook, which are referenced by itemId.
typestringnoValue types can be grouped into 2 main categories: - Scalar: String - Reference: User, Team, Policy, Schedule, Endpoint, Source, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook The value of a Scalar type is defined using the value field. The value of a Reference type is defined using one of the following fields: - itemId - great choice when you know the ID of the target item. - email - your go-to choice when you're referencing users. - name - can be used to reference other items like teams, policies, etc. Not available for Endpoint, SlackIntegration, and ZapierWebhook, which are referenced by itemId. The reference types require the presence of at least one of the three fields: itemId, name, email.
valuestringnoValue when type is String.