resources

package
v1.4.1 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2024 License: Apache-2.0 Imports: 52 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AllowlistsSchema 

func AllowlistsSchema() schema.Schema

func ApiKeySchema 

func ApiKeySchema() schema.Schema

func AppServiceOnOffOnDemandSchema added in v1.1.0 

func AppServiceOnOffOnDemandSchema() schema.Schema

func AppServiceSchema 

func AppServiceSchema() schema.Schema

func AuditLogExportSchema added in v1.2.0 

func AuditLogExportSchema() schema.Schema

func AuditLogSettingsSchema added in v1.2.0 

func AuditLogSettingsSchema() schema.Schema

func BackupScheduleSchema 

func BackupScheduleSchema() schema.Schema

func BackupSchema 

func BackupSchema() schema.Schema

func BucketSchema 

func BucketSchema() schema.Schema

func ClusterOnOffOnDemandSchema added in v1.1.0 

func ClusterOnOffOnDemandSchema() schema.Schema

func ClusterSchema 

func ClusterSchema() schema.Schema

func CollectionSchema added in v1.1.0 

func CollectionSchema() schema.Schema

func DatabaseCredentialSchema 

func DatabaseCredentialSchema() schema.Schema

DatabaseCredentialSchema defines the schema for the terraform provider resource - "DatabaseCredential". This terraform resource directly maps to the database credential created for a Capella cluster. DatabaseCredential resource supports Create, Destroy, Read, Import and List operations.

func FlushBucketSchema added in v1.4.0 

func FlushBucketSchema() schema.Schema

func GsiSchema added in v1.4.0 

func GsiSchema() schema.Schema

func NetworkPeerSchema added in v1.3.0 

func NetworkPeerSchema() schema.Schema

func NewAllowList 

func NewAllowList() resource.Resource

func NewApiKey 

func NewApiKey() resource.Resource

func NewAppService 

func NewAppService() resource.Resource

NewAppService is a helper function to simplify the provider implementation.

func NewAppServiceOnOffOnDemand added in v1.1.0 

func NewAppServiceOnOffOnDemand() resource.Resource

NewAppServiceOnOffOnDemand is a helper function to simplify the provider implementation.

func NewAuditLogExport added in v1.2.0 

func NewAuditLogExport() resource.Resource

func NewAuditLogSettings added in v1.2.0 

func NewAuditLogSettings() resource.Resource

func NewBackup 

func NewBackup() resource.Resource

NewBackup is a helper function to simplify the provider implementation.

func NewBackupSchedule 

func NewBackupSchedule() resource.Resource

NewBackupSchedule is a helper function to simplify the provider implementation.

func NewBucket 

func NewBucket() resource.Resource

NewBucket is a helper function to simplify the provider implementation.

func NewCluster 

func NewCluster() resource.Resource

NewCluster is a helper function to simplify the provider implementation.

func NewClusterOnOffOnDemand added in v1.1.0 

func NewClusterOnOffOnDemand() resource.Resource

NewClusterOnOffOnDemand is a helper function to simplify the provider implementation.

func NewClusterOnOffSchedule added in v1.1.0 

func NewClusterOnOffSchedule() resource.Resource

NewClusterOnOffSchedule is a helper function to simplify the provider implementation.

func NewCollection added in v1.1.0 

func NewCollection() resource.Resource

NewCollection is a helper function to simplify the provider implementation.

func NewDatabaseCredential 

func NewDatabaseCredential() resource.Resource

func NewFlushBucket added in v1.4.0 

func NewFlushBucket() resource.Resource

NewFlushBucket is a helper function to simplify the provider implementation.

func NewGSI added in v1.4.0 

func NewGSI() resource.Resource

func NewNetworkPeer added in v1.3.0 

func NewNetworkPeer() resource.Resource

func NewPrivateEndpoint added in v1.3.0 

func NewPrivateEndpoint() resource.Resource

NewPrivateEndpoint is a helper function to simplify the provider implementation.

func NewPrivateEndpointService added in v1.3.0 

func NewPrivateEndpointService() resource.Resource

NewPrivateEndpointService is a helper function to simplify the provider implementation.

func NewProject 

func NewProject() resource.Resource

func NewSampleBucket added in v1.1.0 

func NewSampleBucket() resource.Resource

NewSampleBucket is a helper function to simplify the provider implementation.

func NewScope added in v1.1.0 

func NewScope() resource.Resource

NewScope is a helper function to simplify the provider implementation.

func NewUser 

func NewUser() resource.Resource

func OnOffScheduleSchema added in v1.1.0 

func OnOffScheduleSchema() schema.Schema

func ProjectSchema 

func ProjectSchema() schema.Schema

func SampleBucketSchema added in v1.1.0 

func SampleBucketSchema() schema.Schema

func ScopeSchema added in v1.1.0 

func ScopeSchema() schema.Schema

func UserSchema 

func UserSchema() schema.Schema

Types

type AllowList 

type AllowList struct {
	*providerschema.Data
}

AllowList is the AllowList resource implementation.

func (*AllowList) Configure 

func (r *AllowList) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure set provider-defined data, clients, etc. that is passed to data sources or resources in the provider.

func (*AllowList) Create 

func (r *AllowList) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new allowlist.

func (*AllowList) Delete 

func (r *AllowList) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the allow list.

func (*AllowList) ImportState 

func (r *AllowList) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote allowlist that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: id=cluster123,project_id=proj123,organization_id=org123 Unfortunately the terraform import CLI doesn't allow us to pass multiple IDs at this point and hence this workaround has been applied.

func (*AllowList) Metadata 

func (r *AllowList) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the allowlist resource type name.

func (*AllowList) Read 

func (r *AllowList) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads project information.

func (*AllowList) Schema 

func (r *AllowList) Schema(ctx context.Context, rsc resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the allowlist resource.

func (*AllowList) Update 

func (r *AllowList) Update(_ context.Context, _ resource.UpdateRequest, _ *resource.UpdateResponse)

Update updates the allowlist.

type ApiKey 

type ApiKey struct {
	*providerschema.Data
}

ApiKey is the ApiKey resource implementation.

func (*ApiKey) Configure 

func (r *ApiKey) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the apiKey resource.

func (*ApiKey) Create 

func (a *ApiKey) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new apiKey.

func (*ApiKey) Delete 

func (a *ApiKey) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the ApiKey.

func (*ApiKey) ImportState 

func (a *ApiKey) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

func (*ApiKey) Metadata 

func (r *ApiKey) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the apiKey resource type name.

func (*ApiKey) Read 

func (a *ApiKey) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads ApiKey information.

func (*ApiKey) Schema 

func (r *ApiKey) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the apiKey resource.

func (*ApiKey) Update 

func (a *ApiKey) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update rotates the ApiKey.

type AppService 

type AppService struct {
	*providerschema.Data
}

AppService is the AppService resource implementation.

func (*AppService) Configure 

func (a *AppService) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the app service resource.

func (*AppService) Create 

func (a *AppService) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new AppService.

func (*AppService) Delete 

func (a *AppService) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the app service.

func (*AppService) ImportState 

func (a *AppService) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote app service that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: id=appService123,organization_id=org123,project_id=proj123,cluster_id=cluster123 Unfortunately the terraform import CLI doesn't allow us to pass multiple IDs at this point and hence this workaround has been applied.

func (*AppService) Metadata 

func (a *AppService) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the AppService resource type name.

func (*AppService) Read 

func (a *AppService) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the app service project information.

func (*AppService) Schema 

func (a *AppService) Schema(_ context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the AppService resource.

func (*AppService) Update 

func (a *AppService) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the AppService.

type AppServiceOnOffOnDemand added in v1.1.0 

type AppServiceOnOffOnDemand struct {
	*providerschema.Data
}

AppServiceOnOffOnDemand is the AppServiceOnOffOnDemand implementation.

func (*AppServiceOnOffOnDemand) Configure added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to ClusterOnOff.

func (*AppServiceOnOffOnDemand) Create added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create allows to switch the cluster to ON or OFF state.

func (*AppServiceOnOffOnDemand) Delete added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Delete(_ context.Context, _ resource.DeleteRequest, _ *resource.DeleteResponse)

func (*AppServiceOnOffOnDemand) ImportState added in v1.1.0 

func (a *AppServiceOnOffOnDemand) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote AppserviceOnOffOnDemand app service that is not created by Terraform.

func (*AppServiceOnOffOnDemand) Metadata added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the AppServiceOnOffOnDemand cluster resource type name.

func (*AppServiceOnOffOnDemand) Read added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Couchbase Capella's v4 does not support a GET endpoint for app service on/off. App service on/off can only access the POST and DELETE endpoint for switching the app service to on and off state respectively. https://docs.couchbase.com/cloud/management-api-reference/index.html#tag/appServices/operation/appServiceOn This read is calling the retrieveAppServiceOnOff func to verify the state with the cluster response.

func (*AppServiceOnOffOnDemand) Schema added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for AppServiceOnOffOnDemand.

func (*AppServiceOnOffOnDemand) Update added in v1.1.0 

func (a *AppServiceOnOffOnDemand) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update allows to update the cluster to ON or OFF state.

type AuditLogExport added in v1.2.0 

type AuditLogExport struct {
	*providerschema.Data
}

AuditLogExport is the resource implementation.

func (*AuditLogExport) Configure added in v1.2.0 

func (a *AuditLogExport) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure set provider-defined data, clients, etc. that is passed to data sources or resources in the provider.

func (*AuditLogExport) Create added in v1.2.0 

func (a *AuditLogExport) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new audit log export job.

func (*AuditLogExport) Delete added in v1.2.0 

func (a *AuditLogExport) Delete(ctx context.Context, _ resource.DeleteRequest, resp *resource.DeleteResponse)

func (*AuditLogExport) ImportState added in v1.2.0 

func (a *AuditLogExport) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

func (*AuditLogExport) Metadata added in v1.2.0 

func (a *AuditLogExport) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the audit log export resource type name.

func (*AuditLogExport) Read added in v1.2.0 

func (a *AuditLogExport) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read gets audit log export information.

func (*AuditLogExport) Schema added in v1.2.0 

func (a *AuditLogExport) Schema(ctx context.Context, rsc resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the audit log export resource.

func (*AuditLogExport) Update added in v1.2.0 

func (a *AuditLogExport) Update(_ context.Context, _ resource.UpdateRequest, resp *resource.UpdateResponse)

Update is not supported as audit log export API does not have update endpoint.

type AuditLogSettings added in v1.2.0 

type AuditLogSettings struct {
	*providerschema.Data
}

AuditLogSettings is the audit log settings resource implementation.

func (*AuditLogSettings) Configure added in v1.2.0 

func (a *AuditLogSettings) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the audit log settings resource.

func (*AuditLogSettings) Create added in v1.2.0 

func (a *AuditLogSettings) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Audit Log API does not have create endpoint. so create is treated as an update.

func (*AuditLogSettings) Delete added in v1.2.0 

func (a *AuditLogSettings) Delete(ctx context.Context, _ resource.DeleteRequest, resp *resource.DeleteResponse)

func (*AuditLogSettings) ImportState added in v1.2.0 

func (a *AuditLogSettings) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

func (*AuditLogSettings) Metadata added in v1.2.0 

func (a *AuditLogSettings) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the audit log settings resource type name.

func (*AuditLogSettings) Read added in v1.2.0 

func (a *AuditLogSettings) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read retrieves audit log settings.

func (*AuditLogSettings) Schema added in v1.2.0 

func (a *AuditLogSettings) Schema(ctx context.Context, rsc resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the audit log settings resource.

func (*AuditLogSettings) Update added in v1.2.0 

func (a *AuditLogSettings) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the audit log settings.

type Backup 

type Backup struct {
	*providerschema.Data
}

Backup is the Backup resource implementation.

func (*Backup) Configure 

func (b *Backup) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured api to the backup resource.

func (*Backup) Create 

func (b *Backup) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new Backup.

func (*Backup) Delete 

func (b *Backup) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the backup.

func (*Backup) ImportState 

func (b *Backup) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote backup that is not created by Terraform.

func (*Backup) Metadata 

func (b *Backup) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the Backup resource type name.

func (*Backup) Read 

func (b *Backup) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads backup information.

func (*Backup) Schema 

func (b *Backup) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the Backup resource.

func (*Backup) Update 

func (b *Backup) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the Backup record.

type BackupSchedule 

type BackupSchedule struct {
	*providerschema.Data
}

BackupSchedule is the BackupSchedule resource implementation.

func (*BackupSchedule) Configure 

func (b *BackupSchedule) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

func (*BackupSchedule) Create 

func (b *BackupSchedule) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new BackupSchedule.

func (*BackupSchedule) Delete 

func (b *BackupSchedule) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the BackupSchedule.

func (*BackupSchedule) ImportState 

func (b *BackupSchedule) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote backup schedule that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, and bucket_id, this function passes the root attribute which is a comma separated string of multiple IDs. example: "organization_id=<orgId>,project_id=<projId>,cluster_id=<clusterId>,bucket_id=<bucketId>

func (*BackupSchedule) Metadata 

func (b *BackupSchedule) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the BackupSchedule resource type name.

func (*BackupSchedule) Read 

func (b *BackupSchedule) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads BackupSchedule information.

func (*BackupSchedule) Schema 

func (b *BackupSchedule) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the BackupSchedule resource.

func (*BackupSchedule) Update 

func (b *BackupSchedule) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the BackupSchedule.

type Bucket 

type Bucket struct {
	*providerschema.Data
}

Bucket is the bucket resource implementation.

func (*Bucket) Configure 

func (c *Bucket) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to the project resource.

func (*Bucket) Create 

func (c *Bucket) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new Bucket.

func (*Bucket) Delete 

func (r *Bucket) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the bucket.

func (*Bucket) ImportState 

func (c *Bucket) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote cluster that is not created by Terraform.

func (*Bucket) Metadata 

func (c *Bucket) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the Bucket resource type name.

func (*Bucket) Read 

func (c *Bucket) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the bucket information.

func (*Bucket) Schema 

func (c *Bucket) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the Bucket resource.

func (*Bucket) Update 

func (c *Bucket) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the bucket.

type Cluster 

type Cluster struct {
	*providerschema.Data
}

Cluster is the Cluster resource implementation.

func (*Cluster) Configure 

func (c *Cluster) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured api to the project resource.

func (*Cluster) Create 

func (c *Cluster) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new Cluster.

func (*Cluster) Delete 

func (r *Cluster) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the cluster.

func (*Cluster) ImportState 

func (c *Cluster) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote cluster that is not created by Terraform.

func (*Cluster) Metadata 

func (c *Cluster) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the Cluster resource type name.

func (*Cluster) Read 

func (c *Cluster) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the cluster information.

func (*Cluster) Schema 

func (c *Cluster) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the Cluster resource.

func (*Cluster) Update 

func (c *Cluster) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the Cluster.

type ClusterOnOffOnDemand added in v1.1.0 

type ClusterOnOffOnDemand struct {
	*providerschema.Data
}

ClusterOnOffOnDemand is the onDemandClusterOnOff resource implementation.

func (*ClusterOnOffOnDemand) Configure added in v1.1.0 

func (c *ClusterOnOffOnDemand) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to ClusterOnOff.

func (*ClusterOnOffOnDemand) Create added in v1.1.0 

func (c *ClusterOnOffOnDemand) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create allows to switch the cluster to ON or OFF state.

func (*ClusterOnOffOnDemand) Delete added in v1.1.0 

func (c *ClusterOnOffOnDemand) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

func (*ClusterOnOffOnDemand) ImportState added in v1.1.0 

func (c *ClusterOnOffOnDemand) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote onDemandClusterOnOff cluster that is not created by Terraform.

func (*ClusterOnOffOnDemand) Metadata added in v1.1.0 

func (c *ClusterOnOffOnDemand) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the ClusterOnOffOnDemand cluster resource type name.

func (*ClusterOnOffOnDemand) Read added in v1.1.0 

func (c *ClusterOnOffOnDemand) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Couchbase Capella's v4 does not support a GET endpoint for cluster on/off. Cluster on/off can only access the POST and DELETE endpoint for switching the cluster to on and off state respectively. https://docs.couchbase.com/cloud/management-api-reference/index.html#tag/clusters/operation/clusterOn This read is calling the retrieveClusterOnOff func to verify the state with the cluster response.

func (*ClusterOnOffOnDemand) Schema added in v1.1.0 

func (c *ClusterOnOffOnDemand) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for ClusterOnOffOnDemand.

func (*ClusterOnOffOnDemand) Update added in v1.1.0 

func (c *ClusterOnOffOnDemand) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update allows to update the cluster to ON or OFF state.

type ClusterOnOffSchedule added in v1.1.0 

type ClusterOnOffSchedule struct {
	*providerschema.Data
}

ClusterOnOffSchedule is the cluster OnOffSchedule resource implementation.

func (*ClusterOnOffSchedule) Configure added in v1.1.0 

func (c *ClusterOnOffSchedule) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the cluster on-off schedule resource.

func (*ClusterOnOffSchedule) Create added in v1.1.0 

func (c *ClusterOnOffSchedule) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new OnOffSchedule.

func (*ClusterOnOffSchedule) Delete added in v1.1.0 

func (c *ClusterOnOffSchedule) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

func (*ClusterOnOffSchedule) ImportState added in v1.1.0 

func (c *ClusterOnOffSchedule) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports an already existing cluster on-off schedule that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: "organization_id=<orgId>,project_id=<projId>,cluster_id=<clusterId>

func (*ClusterOnOffSchedule) Metadata added in v1.1.0 

func (c *ClusterOnOffSchedule) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the OnOffSchedule resource type name.

func (*ClusterOnOffSchedule) Read added in v1.1.0 

func (c *ClusterOnOffSchedule) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

func (*ClusterOnOffSchedule) Schema added in v1.1.0 

func (c *ClusterOnOffSchedule) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the OnOffSchedule resource.

func (*ClusterOnOffSchedule) Update added in v1.1.0 

func (c *ClusterOnOffSchedule) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

type Collection added in v1.1.0 

type Collection struct {
	*providerschema.Data
}

Collection is the collection resource implementation.

func (*Collection) Configure added in v1.1.0 

func (c *Collection) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to the collection resource.

func (*Collection) Create added in v1.1.0 

func (c *Collection) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new collection.

func (*Collection) Delete added in v1.1.0 

func (c *Collection) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the collection.

func (*Collection) ImportState added in v1.1.0 

func (c *Collection) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote collection that is not created by Terraform.

func (*Collection) Metadata added in v1.1.0 

func (c *Collection) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the Collection resource type name.

func (*Collection) Read added in v1.1.0 

func (c *Collection) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the collection information.

func (*Collection) Schema added in v1.1.0 

func (c *Collection) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the Collection resource.

func (*Collection) Update added in v1.1.0 

func (c *Collection) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the collection. Only maxTTL value for the collection can be updated. This endpoint only applies for clusters with server version >= 7.6.0. Collections cannot be updated for clusters with server version < 7.6.0.

type DatabaseCredential 

type DatabaseCredential struct {
	*providerschema.Data
}

DatabaseCredential is the database credential resource implementation.

func (*DatabaseCredential) Configure 

func (r *DatabaseCredential) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the database credential resource.

func (*DatabaseCredential) Create 

func (r *DatabaseCredential) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new database credential. This function will validate the mandatory fields in the resource.CreateRequest before invoking the Capella V4 API.

func (*DatabaseCredential) Delete 

func (r *DatabaseCredential) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the database credential.

func (*DatabaseCredential) ImportState 

func (r *DatabaseCredential) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote database credential that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: id=user123,organization_id=org123,project_id=proj123,cluster_id=cluster123 Unfortunately the terraform import CLI doesn't allow us to pass multiple IDs at this point and hence this workaround has been applied.

func (*DatabaseCredential) Metadata 

func (r *DatabaseCredential) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the name that the database credential will follow in the terraform files. the name as per this function is capella_database_credential.

func (*DatabaseCredential) Read 

func (r *DatabaseCredential) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads database credential information.

func (*DatabaseCredential) Schema 

func (r *DatabaseCredential) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the database credential resource.

func (*DatabaseCredential) Update 

func (r *DatabaseCredential) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the database credential.

type FlushBucket added in v1.4.0 

type FlushBucket struct {
	*providerschema.Data
}

FlushBucket is the bucket resource implementation.

func (*FlushBucket) Configure added in v1.4.0 

func (c *FlushBucket) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured api to the flush bucket resource.

func (*FlushBucket) Create added in v1.4.0 

func (c *FlushBucket) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new flush Bucket.

func (*FlushBucket) Delete added in v1.4.0 

func (r *FlushBucket) Delete(_ context.Context, _ resource.DeleteRequest, _ *resource.DeleteResponse)

func (*FlushBucket) Metadata added in v1.4.0 

func (c *FlushBucket) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the flush Bucket resource type name.

func (*FlushBucket) Read added in v1.4.0 

func (c *FlushBucket) Read(_ context.Context, _ resource.ReadRequest, _ *resource.ReadResponse)

func (*FlushBucket) Schema added in v1.4.0 

func (c *FlushBucket) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the flush Bucket resource.

func (*FlushBucket) Update added in v1.4.0 

func (c *FlushBucket) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

type GSI added in v1.4.0 

type GSI struct {
	*providerschema.Data
}

GSI is the GSI resource implementation.

func (*GSI) Configure added in v1.4.0 

func (g *GSI) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

func (*GSI) Create added in v1.4.0 

func (g *GSI) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create will send a request to create a primary or secondary index.

func (*GSI) Delete added in v1.4.0 

func (g *GSI) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete will send a request to drop an index.

func (*GSI) ImportState added in v1.4.0 

func (g *GSI) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

Importstate is used to import an index on the data plane cluster.

func (*GSI) Metadata added in v1.4.0 

func (g *GSI) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the query index resource type name.

func (*GSI) Read added in v1.4.0 

func (g *GSI) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read will get index properties like index keys, number of replicas, etc.

func (*GSI) Schema added in v1.4.0 

func (g *GSI) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the query index resource.

func (*GSI) Update added in v1.4.0 

func (g *GSI) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update will send a request to alter an index.

func (*GSI) ValidateConfig added in v1.4.0 

func (g *GSI) ValidateConfig(
	ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse,
)

ValidateConfig is used to validate multiple attributes in a resource.

a. For primary indexes, index_keys, where and parition_by must be null. index_name and with are optional. b. For secondary indexes, index_name and index_keys must be valued. where, partition_by and with are optional. c. If build_indexes is provided, all of the other optional properties (except scope_name and collection_name) must be null. d. num_partition can only be set for a partitioned index ie partition_by is valued.

type NetworkPeer added in v1.3.0 

type NetworkPeer struct {
	*providerschema.Data
}

func (*NetworkPeer) Configure added in v1.3.0 

func (n *NetworkPeer) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

func (*NetworkPeer) Create added in v1.3.0 

func (n *NetworkPeer) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create a network peer for the CSP.

func (*NetworkPeer) Delete added in v1.3.0 

func (n *NetworkPeer) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes a network peer of the CSP.

func (*NetworkPeer) ImportState added in v1.3.0 

func (n *NetworkPeer) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

func (*NetworkPeer) Metadata added in v1.3.0 

func (n *NetworkPeer) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

func (*NetworkPeer) Read added in v1.3.0 

func (n *NetworkPeer) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the NetworkPeer information.

func (*NetworkPeer) Schema added in v1.3.0 

func (n *NetworkPeer) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

func (*NetworkPeer) Update added in v1.3.0 

func (n *NetworkPeer) Update(_ context.Context, _ resource.UpdateRequest, resp *resource.UpdateResponse)

Update there is no update API so returns an error.

type PrivateEndpoint added in v1.3.0 

type PrivateEndpoint struct {
	*providerschema.Data
}

PrivateEndpoint is the private endpoint resource implementation.

func (*PrivateEndpoint) Configure added in v1.3.0 

func (p *PrivateEndpoint) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the private endpoint resource.

func (*PrivateEndpoint) Create added in v1.3.0 

func (p *PrivateEndpoint) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create accepts a private endpoint on the CSP.

func (*PrivateEndpoint) Delete added in v1.3.0 

func (p *PrivateEndpoint) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete rejects a private endpoint on the CSP.

func (*PrivateEndpoint) ImportState added in v1.3.0 

func (p *PrivateEndpoint) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a private endpoint to be managed by terraform.

func (*PrivateEndpoint) Metadata added in v1.3.0 

func (p *PrivateEndpoint) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the private endpoint resource type name.

func (*PrivateEndpoint) Read added in v1.3.0 

func (p *PrivateEndpoint) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the private endpoint status.

func (*PrivateEndpoint) Schema added in v1.3.0 

func (p *PrivateEndpoint) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the private endpoint resource.

func (*PrivateEndpoint) Update added in v1.3.0 

func (p *PrivateEndpoint) Update(_ context.Context, _ resource.UpdateRequest, resp *resource.UpdateResponse)

Update there is no update API so returns an error.

type PrivateEndpointService added in v1.3.0 

type PrivateEndpointService struct {
	*providerschema.Data
}

PrivateEndpointService is the scope resource implementation.

func (*PrivateEndpointService) Configure added in v1.3.0 

func (p *PrivateEndpointService) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to the private endpoint service resource.

func (*PrivateEndpointService) Create added in v1.3.0 

func (p *PrivateEndpointService) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create enables private endpoint service.

func (*PrivateEndpointService) Delete added in v1.3.0 

func (p *PrivateEndpointService) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete disables private endpoint service on the cluster.

func (*PrivateEndpointService) ImportState added in v1.3.0 

func (p *PrivateEndpointService) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a private endpoint service status.

func (*PrivateEndpointService) Metadata added in v1.3.0 

func (p *PrivateEndpointService) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the private endpoint service resource type name.

func (*PrivateEndpointService) Read added in v1.3.0 

func (p *PrivateEndpointService) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the private endpoint service status.

func (*PrivateEndpointService) Schema added in v1.3.0 

func (p *PrivateEndpointService) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for a private endpoint service resource.

func (*PrivateEndpointService) Update added in v1.3.0 

func (p *PrivateEndpointService) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update will enable/disable the private endpoint service.

type Project 

type Project struct {
	*providerschema.Data
}

Project is the project resource implementation.

func (*Project) Configure 

func (r *Project) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the provider configured client to the project resource.

func (*Project) Create 

func (r *Project) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new project.

func (*Project) Delete 

func (r *Project) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the project.

func (*Project) ImportState 

func (r *Project) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote project that is not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: id=proj123,organization_id=org123 Unfortunately the terraform import CLI doesn't allow us to pass multiple IDs at this point and hence this workaround has been applied.

func (*Project) Metadata 

func (r *Project) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the project resource type name.

func (*Project) Read 

func (r *Project) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads project information.

func (*Project) Schema 

func (r *Project) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the project resource.

func (*Project) Update 

func (r *Project) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the project.

type SampleBucket added in v1.1.0 

type SampleBucket struct {
	*providerschema.Data
}

SampleBucket is the sample bucket resource implementation.

func (*SampleBucket) Configure added in v1.1.0 

func (s *SampleBucket) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure adds the configured client to the SampleBucket resource.

func (*SampleBucket) Create added in v1.1.0 

func (s *SampleBucket) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create loads a new sample bucket.

func (*SampleBucket) Delete added in v1.1.0 

func (s *SampleBucket) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the SampleBucket.

func (*SampleBucket) ImportState added in v1.1.0 

func (s *SampleBucket) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote sample bucket that is not created by Terraform.

func (*SampleBucket) Metadata added in v1.1.0 

func (s *SampleBucket) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the SampleBucket resource type name.

func (*SampleBucket) Read added in v1.1.0 

func (s *SampleBucket) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads SampleBucket information.

func (*SampleBucket) Schema added in v1.1.0 

func (s *SampleBucket) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the SampleBucket resource.

func (*SampleBucket) Update added in v1.1.0 

func (s *SampleBucket) Update(_ context.Context, _ resource.UpdateRequest, _ *resource.UpdateResponse)

type Scope added in v1.1.0 

type Scope struct {
	*providerschema.Data
}

Scope is the scope resource implementation.

func (*Scope) Configure added in v1.1.0 

func (s *Scope) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure It adds the provider configured api to the scope resource.

func (*Scope) Create added in v1.1.0 

func (s *Scope) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new scope.

func (*Scope) Delete added in v1.1.0 

func (s *Scope) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the scope.

func (*Scope) ImportState added in v1.1.0 

func (s *Scope) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote scope that is not created by Terraform.

func (*Scope) Metadata added in v1.1.0 

func (s *Scope) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the Scope resource type name.

func (*Scope) Read added in v1.1.0 

func (s *Scope) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads the scope information.

func (*Scope) Schema added in v1.1.0 

func (s *Scope) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the Scope resource.

func (*Scope) Update added in v1.1.0 

func (s *Scope) Update(_ context.Context, _ resource.UpdateRequest, _ *resource.UpdateResponse)

Update updates the scope.

type User 

type User struct {
	*providerschema.Data
}

User is the User resource implementation.

func (*User) Configure 

func (r *User) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

Configure sets provider-defined data, clients, etc. that is passed to data sources or resources in the provider.

func (*User) Create 

func (r *User) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

Create creates a new user.

func (*User) Delete 

func (r *User) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

Delete deletes the user.

func (*User) ImportState 

func (r *User) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

ImportState imports a remote user that was not created by Terraform. Since Capella APIs may require multiple IDs, such as organizationId, projectId, clusterId, this function passes the root attribute which is a comma separated string of multiple IDs. example: id=cluster123,project_id=proj123,organization_id=org123 Unfortunately the terraform import CLI doesn't allow us to pass multiple IDs at this point and hence this workaround has been applied.

func (*User) Metadata 

func (r *User) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

Metadata returns the users resource type name.

func (*User) Read 

func (r *User) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

Read reads user information.

func (*User) Schema 

func (r *User) Schema(ctx context.Context, rsc resource.SchemaRequest, resp *resource.SchemaResponse)

Schema defines the schema for the user resource.

func (*User) Update 

func (r *User) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

Update updates the user.

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.