hcpvalidator

Documentation

Overview

hcpvalidator package providers validators for common HCP request attributes.

Index

• func DisplayName() validator.String
• func HTTPSUrl() validator.String
• func ResourceNamePart() validator.String
• func ResourceType() validator.String
• func URL() validator.String

Functions

func DisplayName

func DisplayName() validator.String

DisplayName returns an AttributeValidator which ensures that any configured attribute value:

• Is a string.
• Consists of only characters that are valid for a display name

Null (unconfigured) and unknown (known after apply) values are skipped.

func HTTPSUrl

func HTTPSUrl() validator.String

HTTPSUrl returns an AttributeValidator which ensures that any configured attribute value satisfies requirements of a valid HTTPS URL. Null (unconfigured) and unknown (known after apply) values are skipped.

func ResourceNamePart

func ResourceNamePart() validator.String

ResourceNamePart returns an AttributeValidator which ensures that any configured attribute value:

• Is a string.
• Consists of only characters that are valid for a resource name part

Length is not enforced, and should be validated separately. Null (unconfigured) and unknown (known after apply) values are skipped.

func ResourceType

func ResourceType() validator.String

ResourceType returns an AttributeValidator which ensures that any configured attribute value satisfies requirements. Resource Type must have a format

<resource type> = hashicorp.<service>.<resource>

where <service> and <resource> may contain lower-case alphabetic characters as well as dashes (-).

For example:

• hashicorp.vault.cluster
• hashicorp.network.hvn

Null (unconfigured) and unknown (known after apply) values are skipped.

func URL

func URL() validator.String

URL returns an AttributeValidator which ensures that any configured attribute value satisfies requirements of a valid URL. Null (unconfigured) and unknown (known after apply) values are skipped.