# Packages

iampolicy is a helper package for creating Terraform resources that modify an HCP Resource's IAM Policy.
No description provided by the author

# Functions

AddPlugin will make a call to the Vault service to add a plugin to a Vault cluster.
BatchGetPrincipals retrieves the requested principals in a batch.
CreateAwsDynamicSecret NOTE: currently just needed for tests.
CreateAwsIntegration NOTE: currently just needed for tests.
CreateBoundaryCluster will make a call to the Boundary service to initiate the create Boundary cluster workflow.
CreateConsulCluster will make a call to the Consul service to initiate the create Consul cluster workflow.
CreateCustomerRootACLToken invokes the consul-service endpoint to create privileged tokens for a Consul cluster.
CreateHVNRoute creates a new HVN route.
CreateLogStreamingDestinationOrgFilter will create an HCP Log Streaming Destination Organization Filter.
CreateMongoDBAtlasRotatingSecret NOTE: currently just needed for tests.
CreateMongoDBAtlasRotationIntegration NOTE: currently just needed for tests.
No description provided by the author
CreateSnapshot will make a call to the Consul service to initiate the create Consul snapshot workflow.
CreateVaultCluster will make a call to the Vault service to initiate the create Vault cluster workflow.
CreateVaultClusterAdminToken will make a call to the Vault service to generate an admin token for the Vault cluster that expires after 6 hours.
CreateVaultSecretsApp will create a Vault Secrets application.
CreateVaultSecretsAppSecret will create a Vault Secrets application secret.
DeleteAwsDynamicSecret NOTE: currently just needed for tests.
DeleteAwsIntegration NOTE: currently just needed for tests.
DeleteBoundaryCluster will make a call to the Boundary service to initiate the delete Boundary cluster workflow.
DeleteConsulCluster will make a call to the Consul service to initiate the delete Consul cluster workflow.
DeleteSnapshotByID deletes an HVN route by its ID.
DeleteLogStreamingDestination will delete an HCP Log Streaming Destination.
DeleteMongoDBAtlasRotationIntegration NOTE: currently just needed for tests.
DeletePlugin will make a call to the Vault service to remove a plugin to a Vault cluster.
DeleteSnapshotByID deletes a Consul snapshot by its ID.
DeleteVaultCluster will make a call to the Vault service to initiate the delete Vault cluster workflow.
DeleteVaultPathsFilter will make a call to the Vault service to delete the paths filter for a secondary cluster.
DeleteVaultSecretsApp will delete a Vault Secrets application.
DeleteVaultSecretsAppSecret will delete a Vault Secrets application secret.
GetAction will retrieve an Action using the provided ID by default or by name if the ID is not provided.
GetAddOnByID will retrieve an add-on by ID.
GetAddOnByName will retrieve an add-on by name.
GetAddOnDefinitionByID will retrieve an add-on definition by ID.
GetAddOnDefinitionByName will retrieve an add-on definition by name.
GetApplicationByID will retrieve an application by ID.
GetApplicationByName will retrieve an application by name.
GetApplicationTemplateByID will retrieve a template by ID.
GetApplicationTemplateByName will retrieve a template by name.
GetAvailableHCPConsulVersions gets the list of available Consul versions that HCP supports.
GetAvailableHCPConsulVersionsForLocation gets the list of available Consul versions that HCP supports for the provided location.
GetBoundaryClusterByID gets a Boundary cluster by its ID.
GetBoundaryClusterMaintenanceWindow gets the maintenance window configuration for a Boundary cluster.
GetConsulClientConfigFiles gets a Consul cluster set of client config files.
GetConsulClusterByID gets an Consul cluster by its ID.
GetHvnByID gets an HVN by its ID and location.
GetHVNRoute returns specific HVN route by its ID.
No description provided by the author
GetLogStreamingDestination will get an HCP Log Streaming Destination by its ID and location.
GetParentOrganizationIDByProjectID gets the parent organization ID of a project.
GetPeeringByID gets a peering by its ID, hvnID, and location.
GetProjectByID gets a project by its ID.
No description provided by the author
GetSnapshotByID gets a Consul snapshot by its ID.
GetTGWAttachmentByID gets a TGW attachment by its ID, hvnID, and location.
GetVaultClusterByID gets an Vault cluster by its ID.
GetVaultSecretsApp will read a Vault Secrets application.
IamPrincipalTypeToBindingType converts an IAM principal type to a resource manager binding member type.
No description provided by the author
IsResponseCodeNotFound takes an error returned from a client service request, and returns true if the response code was 404 not found.
ListConsulUpgradeVersions gets the list of available Consul versions that the supplied cluster can upgrade to.
ListHVNRoutes lists the routes for an HVN.
ListPlugins will make a call to the Vault service plugin status api to get all available plugins for the cluster.
NewClient creates a new Client that is capable of making HCP requests.
OpenVaultSecretsAppSecret will retrieve the latest secret for a Vault Secrets app, including it's value.
No description provided by the author
RenameSnapshotByID renames a Consul snapshot by its ID.
Wraps the OrganizationServiceList function in a loop that supports retrying the GET request.
Wraps the ProjectServiceGet function in a loop that supports retrying the GET request.
Wraps the ProjectServiceList function in a loop that supports retrying the GET request.
SetBoundaryClusterMaintenanceWindow updates the maintenance window configuration for a Boundary cluster.
ShouldLog determines if TF_LOG is set to a valid level.
UpdateConsulCluster will make a call to the Consul service to initiate the update Consul cluster workflow.
No description provided by the author
UpdateVaultCluster will make a call to the Vault service to update the Vault cluster configuration.
UpdateVaultClusterPublicIps will make a call to the Vault service to enable or disable public IPs for the Vault cluster.
UpdateVaultMajorVersionUpgradeConfig will make a call to the Vault service to update the major version upgrade config for the Vault cluster.
UpdateVaultPathsFilter will make a call to the Vault service to update the paths filter for a secondary cluster.
UpdateVaultSecretsApp will update an app's description.
WaitForHVNRouteToBeActive will poll the GET HVN route endpoint until the state is ACTIVE, ctx is canceled, or an error occurs.
WaitForOperation will poll the operation wait endpoint until an operation is DONE, ctx is canceled, or consecutive errors occur waiting for operation to complete.
WaitForTGWAttachmentToBeActive will poll the GET TGW attachment endpoint until the state is ACTIVE, ctx is canceled, or an error occurs.
WaitForTGWAttachmentToBePendingAcceptance will poll the GET TGW attachment endpoint until the state is PENDING_ACCEPTANCE, ctx is canceled, or an error occurs.

# Constants

HvnRouteStateActive is the ACTIVE state of an HVN route.
HvnRouteStateCreating is the CREATING state of an HVN route.
HvnRouteStatePending is the PENDING state of an HVN route.
PeeringStateAccepted is the ACCEPTED state of a peering connection.
PeeringStateActive is the ACTIVE state of a peering connection.
PeeringStateCreating is the CREATING state of a peering connection.
PeeringStatePendingAcceptance is the PENDING_ACCEPTANCE state of a peering connection.
TgwAttachmentStateAccepted is the ACCEPTED state of a TGW attachment.
TgwAttachmentStateActive is the ACTIVE state of a TGW attachment.
TgwAttachmentStateCreating is the CREATING state of a TGW attachment.
TgwAttachmentStatePendingAcceptance is the PENDING_ACCEPTANCE state of a TGW attachment.

# Variables

WaitForPeeringToBeAccepted will poll the GET peering endpoint until the state is ACCEPTED, ctx is canceled, or an error occurs.
WaitForPeeringToBeActive will poll the GET peering endpoint until the state is ACTIVE, ctx is canceled, or an error occurs.
WaitForPeeringToBeActiveStates are those from which we'd expect an ACTIVE state to be possible.
WaitForPeeringToBePendingAcceptance will poll the GET peering endpoint until the state is PENDING_ACCEPTANCE, ctx is canceled, or an error occurs.
WaitForTGWAttachmentToBeActiveStates is the set of states of the attachment which we'll wait on.

# Structs

Client is an HCP client capable of making requests on behalf of a service principal.
ClientConfig specifies configuration for the client that interacts with HCP.

# Interfaces

ErrorWithCode is an interface wrapping the error interface to also return the response status code.

# Type aliases

No description provided by the author