Documentation
¶
Overview ¶
Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0
Index ¶
- Constants
- Variables
- func DontDeleteEmptyObject() basetypes.ObjectValue
- func NewAgentTokenEphemeralResource() ephemeral.EphemeralResource
- func NewAuditTrailTokenEphemeralResource() ephemeral.EphemeralResource
- func NewAuditTrailTokenResource() resource.Resource
- func NewDataRetentionPolicyResource() resource.Resource
- func NewFrameworkProvider() provider.Provider
- func NewFrameworkProviderWithDefaultOrg(defaultOrgName string) provider.Provider
- func NewNoCodeModuleDataSource() datasource.DataSource
- func NewNotificationConfigurationResource() resource.Resource
- func NewOrganizationDefaultSettings() resource.Resource
- func NewOrganizationRunTaskDataSource() datasource.DataSource
- func NewOrganizationRunTaskGlobalSettingsDataSource() datasource.DataSource
- func NewOrganizationRunTaskGlobalSettingsResource() resource.Resource
- func NewOrganizationRunTaskResource() resource.Resource
- func NewOrganizationTokenEphemeralResource() ephemeral.EphemeralResource
- func NewOutputsDataSource() datasource.DataSource
- func NewOutputsEphemeralResource() ephemeral.EphemeralResource
- func NewPolicySetParameterResource() resource.Resource
- func NewProjectDataSource() datasource.DataSource
- func NewProjectResource() resource.Resource
- func NewProjectsDataSource() datasource.DataSource
- func NewRegistryGPGKeyDataSource() datasource.DataSource
- func NewRegistryGPGKeyResource() resource.Resource
- func NewRegistryGPGKeysDataSource() datasource.DataSource
- func NewRegistryModuleDataSource() datasource.DataSource
- func NewRegistryProviderDataSource() datasource.DataSource
- func NewRegistryProviderResource() resource.Resource
- func NewRegistryProvidersDataSource() datasource.DataSource
- func NewResourceVariable() resource.Resource
- func NewResourceWorkspaceSettings() resource.Resource
- func NewSAMLSettingsDataSource() datasource.DataSource
- func NewSAMLSettingsResource() resource.Resource
- func NewSSHKey() resource.Resource
- func NewStackResource() resource.Resource
- func NewTeamNotificationConfigurationResource() resource.Resource
- func NewTeamTokenEphemeralResource() ephemeral.EphemeralResource
- func NewTeamTokenResource() resource.Resource
- func NewTestVariableResource() resource.Resource
- func NewVariablesDataSource() datasource.DataSource
- func NewWorkspaceRunTaskDataSource() datasource.DataSource
- func NewWorkspaceRunTaskResource() resource.Resource
- func Provider() *schema.Provider
- type AgentTokenEphemeralResource
- func (e *AgentTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, ...)
- func (e *AgentTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, ...)
- func (e *AgentTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
- func (e *AgentTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, ...)
- type AttrGettable
- type AuditTrailTokenEphemeralResource
- func (e *AuditTrailTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, ...)
- func (e *AuditTrailTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, ...)
- func (e *AuditTrailTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
- func (e *AuditTrailTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, ...)
- type ConfiguredClient
- type FrameworkProviderConfig
- type OrganizationTokenEphemeralResource
- func (e *OrganizationTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, ...)
- func (e *OrganizationTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, ...)
- func (e *OrganizationTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
- func (e *OrganizationTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, ...)
- type TeamTokenEphemeralResource
- func (e *TeamTokenEphemeralResource) Close(ctx context.Context, req ephemeral.CloseRequest, resp *ephemeral.CloseResponse)
- func (e *TeamTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, ...)
- func (e *TeamTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, ...)
- func (e *TeamTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
- func (e *TeamTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, ...)
- type TeamTokenEphemeralResourceModel
- type TeamTokenPrivateData
Constants ¶
const ( RemoteExecutionMode = "remote" LocalExecutionMode = "local" AgentExecutionMode = "agent" DefaultExecutionMode = RemoteExecutionMode )
Variables ¶
var ( ValidExecutionModes = []string{ AgentExecutionMode, LocalExecutionMode, RemoteExecutionMode, } )
Functions ¶
func DontDeleteEmptyObject ¶ added in v0.57.0
func DontDeleteEmptyObject() basetypes.ObjectValue
func NewAgentTokenEphemeralResource ¶ added in v0.65.0
func NewAgentTokenEphemeralResource() ephemeral.EphemeralResource
func NewAuditTrailTokenEphemeralResource ¶ added in v0.65.0
func NewAuditTrailTokenEphemeralResource() ephemeral.EphemeralResource
func NewAuditTrailTokenResource ¶ added in v0.61.0
func NewDataRetentionPolicyResource ¶ added in v0.57.0
func NewFrameworkProvider ¶
NewFrameworkProvider is a helper function for initializing the portion of the tfe provider implemented via the terraform-plugin-framework.
func NewFrameworkProviderWithDefaultOrg ¶ added in v0.65.0
NewFrameworkProviderWithDefaultOrg is a helper function for initializing a framework provider with a default organization name.
func NewNoCodeModuleDataSource ¶ added in v0.52.0
func NewNoCodeModuleDataSource() datasource.DataSource
NewNoCodeModuleDataSource is a helper function to simplify the implementation.
func NewNotificationConfigurationResource ¶ added in v0.65.0
NewNotificationConfigurationResource
func NewOrganizationDefaultSettings ¶ added in v0.65.0
func NewOrganizationRunTaskDataSource ¶ added in v0.54.0
func NewOrganizationRunTaskDataSource() datasource.DataSource
NewOrganizationRunTaskDataSource is a helper function to simplify the provider implementation.
func NewOrganizationRunTaskGlobalSettingsDataSource ¶ added in v0.57.0
func NewOrganizationRunTaskGlobalSettingsDataSource() datasource.DataSource
func NewOrganizationRunTaskGlobalSettingsResource ¶ added in v0.57.0
func NewOrganizationRunTaskResource ¶ added in v0.54.0
func NewOrganizationTokenEphemeralResource ¶ added in v0.65.0
func NewOrganizationTokenEphemeralResource() ephemeral.EphemeralResource
func NewOutputsDataSource ¶ added in v0.65.0
func NewOutputsDataSource() datasource.DataSource
func NewOutputsEphemeralResource ¶ added in v0.65.0
func NewOutputsEphemeralResource() ephemeral.EphemeralResource
func NewPolicySetParameterResource ¶ added in v0.65.0
func NewProjectDataSource ¶ added in v0.65.0
func NewProjectDataSource() datasource.DataSource
func NewProjectResource ¶ added in v0.65.0
func NewProjectsDataSource ¶ added in v0.60.0
func NewProjectsDataSource() datasource.DataSource
NewProjectsDataSource is a helper function to simplify the provider implementation.
func NewRegistryGPGKeyDataSource ¶ added in v0.51.0
func NewRegistryGPGKeyDataSource() datasource.DataSource
NewRegistryGPGKeyDataSource is a helper function to simplify the provider implementation.
func NewRegistryGPGKeyResource ¶ added in v0.51.0
func NewRegistryGPGKeysDataSource ¶ added in v0.51.0
func NewRegistryGPGKeysDataSource() datasource.DataSource
NewRegistryGPGKeysDataSource is a helper function to simplify the provider implementation.
func NewRegistryModuleDataSource ¶ added in v0.65.0
func NewRegistryModuleDataSource() datasource.DataSource
NewModuleDataSource is a helper function to simplify the implementation.
func NewRegistryProviderDataSource ¶ added in v0.52.0
func NewRegistryProviderDataSource() datasource.DataSource
NewRegistryProviderDataSource is a helper function to simplify the provider implementation.
func NewRegistryProviderResource ¶ added in v0.52.0
func NewRegistryProvidersDataSource ¶ added in v0.52.0
func NewRegistryProvidersDataSource() datasource.DataSource
NewRegistryProvidersDataSource is a helper function to simplify the provider implementation.
func NewResourceVariable ¶
NewResourceVariable is a resource function for the framework provider.
func NewResourceWorkspaceSettings ¶ added in v0.51.0
func NewSAMLSettingsDataSource ¶
func NewSAMLSettingsDataSource() datasource.DataSource
NewSAMLSettingsDataSource is a helper function to simplify the provider implementation.
func NewSAMLSettingsResource ¶
NewSAMLSettingsResource is a resource function for the framework provider.
func NewStackResource ¶ added in v0.57.0
func NewTeamNotificationConfigurationResource ¶ added in v0.63.0
func NewTeamTokenEphemeralResource ¶ added in v0.65.0
func NewTeamTokenEphemeralResource() ephemeral.EphemeralResource
func NewTeamTokenResource ¶ added in v0.65.0
func NewTestVariableResource ¶ added in v0.54.0
func NewVariablesDataSource ¶ added in v0.65.0
func NewVariablesDataSource() datasource.DataSource
NewVariablesDataSource is a helper function to simplify the provider implementation.
func NewWorkspaceRunTaskDataSource ¶ added in v0.54.0
func NewWorkspaceRunTaskDataSource() datasource.DataSource
func NewWorkspaceRunTaskResource ¶ added in v0.54.0
Types ¶
type AgentTokenEphemeralResource ¶ added in v0.65.0
type AgentTokenEphemeralResource struct {
// contains filtered or unexported fields
}
func (*AgentTokenEphemeralResource) Configure ¶ added in v0.65.0
func (e *AgentTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, resp *ephemeral.ConfigureResponse)
Configure adds the provider configured client to the data source.
func (*AgentTokenEphemeralResource) Metadata ¶ added in v0.65.0
func (e *AgentTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, resp *ephemeral.MetadataResponse)
func (*AgentTokenEphemeralResource) Open ¶ added in v0.65.0
func (e *AgentTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
The request contains the configuration supplied to Terraform for the ephemeral resource. The response contains the ephemeral result data. The data is defined by the schema of the ephemeral resource.
func (*AgentTokenEphemeralResource) Schema ¶ added in v0.65.0
func (e *AgentTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, resp *ephemeral.SchemaResponse)
defines a schema describing what data is available in the ephemeral resource's configuration and result data.
type AttrGettable ¶
type AttrGettable interface {
GetAttribute(ctx context.Context, path path.Path, target interface{}) diag.Diagnostics
}
AttrGettable is a small enabler for helper functions that need to read one attribute of a Configuration, Plan, or State.
type AuditTrailTokenEphemeralResource ¶ added in v0.65.0
type AuditTrailTokenEphemeralResource struct {
// contains filtered or unexported fields
}
func (*AuditTrailTokenEphemeralResource) Configure ¶ added in v0.65.0
func (e *AuditTrailTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, resp *ephemeral.ConfigureResponse)
Configure adds the provider configured client to the data source.
func (*AuditTrailTokenEphemeralResource) Metadata ¶ added in v0.65.0
func (e *AuditTrailTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, resp *ephemeral.MetadataResponse)
func (*AuditTrailTokenEphemeralResource) Open ¶ added in v0.65.0
func (e *AuditTrailTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
func (*AuditTrailTokenEphemeralResource) Schema ¶ added in v0.65.0
func (e *AuditTrailTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, resp *ephemeral.SchemaResponse)
type ConfiguredClient ¶
ConfiguredClient wraps the tfe.Client the provider uses, plus the default organization name to be used by resources that need an organization but don't specify one.
type FrameworkProviderConfig ¶
type FrameworkProviderConfig struct { Hostname types.String `tfsdk:"hostname"` Token types.String `tfsdk:"token"` Organization types.String `tfsdk:"organization"` SSLSkipVerify types.Bool `tfsdk:"ssl_skip_verify"` }
FrameworkProviderConfig is a helper type for extracting the provider configuration from the provider block.
type OrganizationTokenEphemeralResource ¶ added in v0.65.0
type OrganizationTokenEphemeralResource struct {
// contains filtered or unexported fields
}
func (*OrganizationTokenEphemeralResource) Configure ¶ added in v0.65.0
func (e *OrganizationTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, resp *ephemeral.ConfigureResponse)
Configure adds the provider configured client to the data source.
func (*OrganizationTokenEphemeralResource) Metadata ¶ added in v0.65.0
func (e *OrganizationTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, resp *ephemeral.MetadataResponse)
func (*OrganizationTokenEphemeralResource) Open ¶ added in v0.65.0
func (e *OrganizationTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
func (*OrganizationTokenEphemeralResource) Schema ¶ added in v0.65.0
func (e *OrganizationTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, resp *ephemeral.SchemaResponse)
type TeamTokenEphemeralResource ¶ added in v0.65.0
type TeamTokenEphemeralResource struct {
// contains filtered or unexported fields
}
func (*TeamTokenEphemeralResource) Close ¶ added in v0.66.0
func (e *TeamTokenEphemeralResource) Close(ctx context.Context, req ephemeral.CloseRequest, resp *ephemeral.CloseResponse)
func (*TeamTokenEphemeralResource) Configure ¶ added in v0.65.0
func (e *TeamTokenEphemeralResource) Configure(_ context.Context, req ephemeral.ConfigureRequest, resp *ephemeral.ConfigureResponse)
Configure adds the provider configured client to the data source.
func (*TeamTokenEphemeralResource) Metadata ¶ added in v0.65.0
func (e *TeamTokenEphemeralResource) Metadata(ctx context.Context, req ephemeral.MetadataRequest, resp *ephemeral.MetadataResponse)
func (*TeamTokenEphemeralResource) Open ¶ added in v0.65.0
func (e *TeamTokenEphemeralResource) Open(ctx context.Context, req ephemeral.OpenRequest, resp *ephemeral.OpenResponse)
func (*TeamTokenEphemeralResource) Schema ¶ added in v0.65.0
func (e *TeamTokenEphemeralResource) Schema(ctx context.Context, req ephemeral.SchemaRequest, resp *ephemeral.SchemaResponse)
type TeamTokenEphemeralResourceModel ¶ added in v0.65.0
type TeamTokenPrivateData ¶ added in v0.66.0
Source Files
¶
- agent_pool_helpers.go
- attribute_helpers.go
- client_capabilites.go
- data_retention_policy.go
- data_source_agent_pool.go
- data_source_github_app_installation.go
- data_source_ip_ranges.go
- data_source_no_code_module.go
- data_source_oauth_client.go
- data_source_organization.go
- data_source_organization_members.go
- data_source_organization_membership.go
- data_source_organization_run_task.go
- data_source_organization_run_task_global_settings.go
- data_source_organization_tags.go
- data_source_organizations.go
- data_source_outputs.go
- data_source_policy_set.go
- data_source_project.go
- data_source_projects.go
- data_source_registry_gpg_key.go
- data_source_registry_gpg_keys.go
- data_source_registry_module.go
- data_source_registry_provider.go
- data_source_registry_providers.go
- data_source_saml_settings.go
- data_source_slug.go
- data_source_ssh_key.go
- data_source_team.go
- data_source_team_access.go
- data_source_team_project_access.go
- data_source_teams.go
- data_source_variable_set.go
- data_source_variables.go
- data_source_workspace.go
- data_source_workspace_ids.go
- data_source_workspace_run_task.go
- ephemeral_resource_agent_token.go
- ephemeral_resource_audit_trail_token.go
- ephemeral_resource_organization_token.go
- ephemeral_resource_outputs.go
- ephemeral_resource_team_token.go
- github_app_installation_helpers.go
- gpg_key.go
- id_helpers.go
- oauth_client_helpers.go
- organization_members_helpers.go
- provider.go
- provider_custom_diffs.go
- provider_next.go
- resource_tfe_admin_organization_settings.go
- resource_tfe_agent_pool.go
- resource_tfe_agent_pool_allowed_workspaces.go
- resource_tfe_agent_token.go
- resource_tfe_audit_trail_token.go
- resource_tfe_data_retention_policy.go
- resource_tfe_no_code_module.go
- resource_tfe_notification_configuration.go
- resource_tfe_oauth_client.go
- resource_tfe_opa_version.go
- resource_tfe_organization.go
- resource_tfe_organization_default_settings.go
- resource_tfe_organization_membership.go
- resource_tfe_organization_module_sharing.go
- resource_tfe_organization_run_task.go
- resource_tfe_organization_run_task_global_settings.go
- resource_tfe_organization_token.go
- resource_tfe_policy.go
- resource_tfe_policy_set.go
- resource_tfe_policy_set_parameter.go
- resource_tfe_project.go
- resource_tfe_project_oauth_client_.go
- resource_tfe_project_policy_set.go
- resource_tfe_project_variable_set.go
- resource_tfe_registry_gpg_key.go
- resource_tfe_registry_module.go
- resource_tfe_registry_provider.go
- resource_tfe_run_trigger.go
- resource_tfe_saml_settings.go
- resource_tfe_sentinel_policy.go
- resource_tfe_sentinel_version.go
- resource_tfe_ssh_key.go
- resource_tfe_stack.go
- resource_tfe_team.go
- resource_tfe_team_access.go
- resource_tfe_team_access_migrate.go
- resource_tfe_team_member.go
- resource_tfe_team_members.go
- resource_tfe_team_notification_configuration.go
- resource_tfe_team_organization_member.go
- resource_tfe_team_organization_members.go
- resource_tfe_team_project_access.go
- resource_tfe_team_token.go
- resource_tfe_terraform_version.go
- resource_tfe_test_variable.go
- resource_tfe_variable.go
- resource_tfe_variable_set.go
- resource_tfe_workspace.go
- resource_tfe_workspace_migrate.go
- resource_tfe_workspace_policy_set.go
- resource_tfe_workspace_policy_set_exclusion.go
- resource_tfe_workspace_run.go
- resource_tfe_workspace_run_task.go
- resource_tfe_workspace_run_task_schemas.go
- resource_tfe_workspace_settings.go
- resource_tfe_workspace_variable_set.go
- run_task_helpers.go
- stack.go
- team_helpers.go
- tool_helpers.go
- workspace_helpers.go
- workspace_run_helpers.go