Documentation
¶
Index ¶
- type Backup
- type BackupArgs
- type BackupArray
- type BackupArrayInput
- type BackupArrayOutput
- type BackupInput
- type BackupMap
- type BackupMapInput
- type BackupMapOutput
- type BackupOutput
- func (o BackupOutput) CapacityGb() pulumi.StringOutput
- func (o BackupOutput) CreateTime() pulumi.StringOutput
- func (o BackupOutput) Description() pulumi.StringPtrOutput
- func (o BackupOutput) DownloadBytes() pulumi.StringOutput
- func (o BackupOutput) EffectiveLabels() pulumi.StringMapOutput
- func (BackupOutput) ElementType() reflect.Type
- func (o BackupOutput) KmsKeyName() pulumi.StringOutput
- func (o BackupOutput) Labels() pulumi.StringMapOutput
- func (o BackupOutput) Location() pulumi.StringOutput
- func (o BackupOutput) Name() pulumi.StringOutput
- func (o BackupOutput) Project() pulumi.StringOutput
- func (o BackupOutput) PulumiLabels() pulumi.StringMapOutput
- func (o BackupOutput) SourceFileShare() pulumi.StringOutput
- func (o BackupOutput) SourceInstance() pulumi.StringOutput
- func (o BackupOutput) SourceInstanceTier() pulumi.StringOutput
- func (o BackupOutput) State() pulumi.StringOutput
- func (o BackupOutput) StorageBytes() pulumi.StringOutput
- func (o BackupOutput) ToBackupOutput() BackupOutput
- func (o BackupOutput) ToBackupOutputWithContext(ctx context.Context) BackupOutput
- type BackupState
- type Instance
- type InstanceArgs
- type InstanceArray
- type InstanceArrayInput
- type InstanceArrayOutput
- type InstanceFileShares
- type InstanceFileSharesArgs
- func (InstanceFileSharesArgs) ElementType() reflect.Type
- func (i InstanceFileSharesArgs) ToInstanceFileSharesOutput() InstanceFileSharesOutput
- func (i InstanceFileSharesArgs) ToInstanceFileSharesOutputWithContext(ctx context.Context) InstanceFileSharesOutput
- func (i InstanceFileSharesArgs) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
- func (i InstanceFileSharesArgs) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
- type InstanceFileSharesInput
- type InstanceFileSharesNfsExportOption
- type InstanceFileSharesNfsExportOptionArgs
- func (InstanceFileSharesNfsExportOptionArgs) ElementType() reflect.Type
- func (i InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutput() InstanceFileSharesNfsExportOptionOutput
- func (i InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionOutput
- type InstanceFileSharesNfsExportOptionArray
- func (InstanceFileSharesNfsExportOptionArray) ElementType() reflect.Type
- func (i InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutput() InstanceFileSharesNfsExportOptionArrayOutput
- func (i InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionArrayOutput
- type InstanceFileSharesNfsExportOptionArrayInput
- type InstanceFileSharesNfsExportOptionArrayOutput
- func (InstanceFileSharesNfsExportOptionArrayOutput) ElementType() reflect.Type
- func (o InstanceFileSharesNfsExportOptionArrayOutput) Index(i pulumi.IntInput) InstanceFileSharesNfsExportOptionOutput
- func (o InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutput() InstanceFileSharesNfsExportOptionArrayOutput
- func (o InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionArrayOutput
- type InstanceFileSharesNfsExportOptionInput
- type InstanceFileSharesNfsExportOptionOutput
- func (o InstanceFileSharesNfsExportOptionOutput) AccessMode() pulumi.StringPtrOutput
- func (o InstanceFileSharesNfsExportOptionOutput) AnonGid() pulumi.IntPtrOutput
- func (o InstanceFileSharesNfsExportOptionOutput) AnonUid() pulumi.IntPtrOutput
- func (InstanceFileSharesNfsExportOptionOutput) ElementType() reflect.Type
- func (o InstanceFileSharesNfsExportOptionOutput) IpRanges() pulumi.StringArrayOutput
- func (o InstanceFileSharesNfsExportOptionOutput) SquashMode() pulumi.StringPtrOutput
- func (o InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutput() InstanceFileSharesNfsExportOptionOutput
- func (o InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionOutput
- type InstanceFileSharesOutput
- func (o InstanceFileSharesOutput) CapacityGb() pulumi.IntOutput
- func (InstanceFileSharesOutput) ElementType() reflect.Type
- func (o InstanceFileSharesOutput) Name() pulumi.StringOutput
- func (o InstanceFileSharesOutput) NfsExportOptions() InstanceFileSharesNfsExportOptionArrayOutput
- func (o InstanceFileSharesOutput) SourceBackup() pulumi.StringPtrOutput
- func (o InstanceFileSharesOutput) ToInstanceFileSharesOutput() InstanceFileSharesOutput
- func (o InstanceFileSharesOutput) ToInstanceFileSharesOutputWithContext(ctx context.Context) InstanceFileSharesOutput
- func (o InstanceFileSharesOutput) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
- func (o InstanceFileSharesOutput) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
- type InstanceFileSharesPtrInput
- type InstanceFileSharesPtrOutput
- func (o InstanceFileSharesPtrOutput) CapacityGb() pulumi.IntPtrOutput
- func (o InstanceFileSharesPtrOutput) Elem() InstanceFileSharesOutput
- func (InstanceFileSharesPtrOutput) ElementType() reflect.Type
- func (o InstanceFileSharesPtrOutput) Name() pulumi.StringPtrOutput
- func (o InstanceFileSharesPtrOutput) NfsExportOptions() InstanceFileSharesNfsExportOptionArrayOutput
- func (o InstanceFileSharesPtrOutput) SourceBackup() pulumi.StringPtrOutput
- func (o InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
- func (o InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
- type InstanceInput
- type InstanceMap
- type InstanceMapInput
- type InstanceMapOutput
- type InstanceNetwork
- type InstanceNetworkArgs
- type InstanceNetworkArray
- type InstanceNetworkArrayInput
- type InstanceNetworkArrayOutput
- func (InstanceNetworkArrayOutput) ElementType() reflect.Type
- func (o InstanceNetworkArrayOutput) Index(i pulumi.IntInput) InstanceNetworkOutput
- func (o InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutput() InstanceNetworkArrayOutput
- func (o InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutputWithContext(ctx context.Context) InstanceNetworkArrayOutput
- type InstanceNetworkInput
- type InstanceNetworkOutput
- func (o InstanceNetworkOutput) ConnectMode() pulumi.StringPtrOutput
- func (InstanceNetworkOutput) ElementType() reflect.Type
- func (o InstanceNetworkOutput) IpAddresses() pulumi.StringArrayOutput
- func (o InstanceNetworkOutput) Modes() pulumi.StringArrayOutput
- func (o InstanceNetworkOutput) Network() pulumi.StringOutput
- func (o InstanceNetworkOutput) ReservedIpRange() pulumi.StringPtrOutput
- func (o InstanceNetworkOutput) ToInstanceNetworkOutput() InstanceNetworkOutput
- func (o InstanceNetworkOutput) ToInstanceNetworkOutputWithContext(ctx context.Context) InstanceNetworkOutput
- type InstanceOutput
- func (o InstanceOutput) CreateTime() pulumi.StringOutput
- func (o InstanceOutput) Description() pulumi.StringPtrOutput
- func (o InstanceOutput) EffectiveLabels() pulumi.StringMapOutput
- func (InstanceOutput) ElementType() reflect.Type
- func (o InstanceOutput) Etag() pulumi.StringOutput
- func (o InstanceOutput) FileShares() InstanceFileSharesOutput
- func (o InstanceOutput) KmsKeyName() pulumi.StringPtrOutput
- func (o InstanceOutput) Labels() pulumi.StringMapOutput
- func (o InstanceOutput) Location() pulumi.StringOutput
- func (o InstanceOutput) Name() pulumi.StringOutput
- func (o InstanceOutput) Networks() InstanceNetworkArrayOutput
- func (o InstanceOutput) Project() pulumi.StringOutput
- func (o InstanceOutput) PulumiLabels() pulumi.StringMapOutput
- func (o InstanceOutput) Tier() pulumi.StringOutput
- func (o InstanceOutput) ToInstanceOutput() InstanceOutput
- func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
- func (o InstanceOutput) Zone() pulumi.StringOutputdeprecated
- type InstanceState
- type Snapshot
- type SnapshotArgs
- type SnapshotArray
- type SnapshotArrayInput
- type SnapshotArrayOutput
- type SnapshotInput
- type SnapshotMap
- type SnapshotMapInput
- type SnapshotMapOutput
- type SnapshotOutput
- func (o SnapshotOutput) CreateTime() pulumi.StringOutput
- func (o SnapshotOutput) Description() pulumi.StringPtrOutput
- func (o SnapshotOutput) EffectiveLabels() pulumi.StringMapOutput
- func (SnapshotOutput) ElementType() reflect.Type
- func (o SnapshotOutput) FilesystemUsedBytes() pulumi.StringOutput
- func (o SnapshotOutput) Instance() pulumi.StringOutput
- func (o SnapshotOutput) Labels() pulumi.StringMapOutput
- func (o SnapshotOutput) Location() pulumi.StringOutput
- func (o SnapshotOutput) Name() pulumi.StringOutput
- func (o SnapshotOutput) Project() pulumi.StringOutput
- func (o SnapshotOutput) PulumiLabels() pulumi.StringMapOutput
- func (o SnapshotOutput) State() pulumi.StringOutput
- func (o SnapshotOutput) ToSnapshotOutput() SnapshotOutput
- func (o SnapshotOutput) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
- type SnapshotState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backup ¶
type Backup struct { pulumi.CustomResourceState // The amount of bytes needed to allocate a full copy of the snapshot content. CapacityGb pulumi.StringOutput `pulumi:"capacityGb"` // The time when the snapshot was created in RFC3339 text format. CreateTime pulumi.StringOutput `pulumi:"createTime"` // A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrOutput `pulumi:"description"` // Amount of bytes that will be downloaded if the backup is restored. DownloadBytes pulumi.StringOutput `pulumi:"downloadBytes"` // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapOutput `pulumi:"effectiveLabels"` // KMS key name used for data encryption. KmsKeyName pulumi.StringOutput `pulumi:"kmsKeyName"` // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapOutput `pulumi:"labels"` // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. // // *** Location pulumi.StringOutput `pulumi:"location"` // The resource name of the backup. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringOutput `pulumi:"name"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapOutput `pulumi:"pulumiLabels"` SourceFileShare pulumi.StringOutput `pulumi:"sourceFileShare"` // The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup. SourceInstance pulumi.StringOutput `pulumi:"sourceInstance"` // The service tier of the source Cloud Filestore instance that this backup is created from. SourceInstanceTier pulumi.StringOutput `pulumi:"sourceInstanceTier"` // The backup state. State pulumi.StringOutput `pulumi:"state"` // The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. StorageBytes pulumi.StringOutput `pulumi:"storageBytes"` }
A Google Cloud Filestore backup.
To get more information about Backup, see:
* [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.backups) * How-to Guides
- [Official Documentation](https://cloud.google.com/filestore/docs/backups)
- [Creating Backups](https://cloud.google.com/filestore/docs/create-backups)
## Example Usage ### Filestore Backup Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ Location: pulumi.String("us-central1-b"), Tier: pulumi.String("BASIC_HDD"), FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(1024), Name: pulumi.String("share1"), }, Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ Network: pulumi.String("default"), Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, ConnectMode: pulumi.String("DIRECT_PEERING"), }, }, }) if err != nil { return err } _, err = filestore.NewBackup(ctx, "backup", &filestore.BackupArgs{ Location: pulumi.String("us-central1"), Description: pulumi.String("This is a filestore backup for the test instance"), SourceInstance: instance.ID(), SourceFileShare: pulumi.String("share1"), Labels: pulumi.StringMap{ "files": pulumi.String("label1"), "other-label": pulumi.String("label2"), }, }) if err != nil { return err } return nil }) }
```
## Import
Backup can be imported using any of these accepted formats* `projects/{{project}}/locations/{{location}}/backups/{{name}}` * `{{project}}/{{location}}/{{name}}` * `{{location}}/{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Backup using one of the formats above. For exampletf import {
id = "projects/{{project}}/locations/{{location}}/backups/{{name}}" to = google_filestore_backup.default }
```sh
$ pulumi import gcp:filestore/backup:Backup When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Backup can be imported using one of the formats above. For example
```
```sh
$ pulumi import gcp:filestore/backup:Backup default projects/{{project}}/locations/{{location}}/backups/{{name}}
```
```sh
$ pulumi import gcp:filestore/backup:Backup default {{project}}/{{location}}/{{name}}
```
```sh
$ pulumi import gcp:filestore/backup:Backup default {{location}}/{{name}}
```
func GetBackup ¶
func GetBackup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *BackupState, opts ...pulumi.ResourceOption) (*Backup, error)
GetBackup gets an existing Backup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewBackup ¶
func NewBackup(ctx *pulumi.Context, name string, args *BackupArgs, opts ...pulumi.ResourceOption) (*Backup, error)
NewBackup registers a new resource with the given unique name, arguments, and options.
func (*Backup) ElementType ¶
func (*Backup) ToBackupOutput ¶
func (i *Backup) ToBackupOutput() BackupOutput
func (*Backup) ToBackupOutputWithContext ¶
func (i *Backup) ToBackupOutputWithContext(ctx context.Context) BackupOutput
type BackupArgs ¶
type BackupArgs struct { // A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. // // *** Location pulumi.StringInput // The resource name of the backup. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput SourceFileShare pulumi.StringInput // The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup. SourceInstance pulumi.StringInput }
The set of arguments for constructing a Backup resource.
func (BackupArgs) ElementType ¶
func (BackupArgs) ElementType() reflect.Type
type BackupArray ¶
type BackupArray []BackupInput
func (BackupArray) ElementType ¶
func (BackupArray) ElementType() reflect.Type
func (BackupArray) ToBackupArrayOutput ¶
func (i BackupArray) ToBackupArrayOutput() BackupArrayOutput
func (BackupArray) ToBackupArrayOutputWithContext ¶
func (i BackupArray) ToBackupArrayOutputWithContext(ctx context.Context) BackupArrayOutput
type BackupArrayInput ¶
type BackupArrayInput interface { pulumi.Input ToBackupArrayOutput() BackupArrayOutput ToBackupArrayOutputWithContext(context.Context) BackupArrayOutput }
BackupArrayInput is an input type that accepts BackupArray and BackupArrayOutput values. You can construct a concrete instance of `BackupArrayInput` via:
BackupArray{ BackupArgs{...} }
type BackupArrayOutput ¶
type BackupArrayOutput struct{ *pulumi.OutputState }
func (BackupArrayOutput) ElementType ¶
func (BackupArrayOutput) ElementType() reflect.Type
func (BackupArrayOutput) Index ¶
func (o BackupArrayOutput) Index(i pulumi.IntInput) BackupOutput
func (BackupArrayOutput) ToBackupArrayOutput ¶
func (o BackupArrayOutput) ToBackupArrayOutput() BackupArrayOutput
func (BackupArrayOutput) ToBackupArrayOutputWithContext ¶
func (o BackupArrayOutput) ToBackupArrayOutputWithContext(ctx context.Context) BackupArrayOutput
type BackupInput ¶
type BackupInput interface { pulumi.Input ToBackupOutput() BackupOutput ToBackupOutputWithContext(ctx context.Context) BackupOutput }
type BackupMap ¶
type BackupMap map[string]BackupInput
func (BackupMap) ElementType ¶
func (BackupMap) ToBackupMapOutput ¶
func (i BackupMap) ToBackupMapOutput() BackupMapOutput
func (BackupMap) ToBackupMapOutputWithContext ¶
func (i BackupMap) ToBackupMapOutputWithContext(ctx context.Context) BackupMapOutput
type BackupMapInput ¶
type BackupMapInput interface { pulumi.Input ToBackupMapOutput() BackupMapOutput ToBackupMapOutputWithContext(context.Context) BackupMapOutput }
BackupMapInput is an input type that accepts BackupMap and BackupMapOutput values. You can construct a concrete instance of `BackupMapInput` via:
BackupMap{ "key": BackupArgs{...} }
type BackupMapOutput ¶
type BackupMapOutput struct{ *pulumi.OutputState }
func (BackupMapOutput) ElementType ¶
func (BackupMapOutput) ElementType() reflect.Type
func (BackupMapOutput) MapIndex ¶
func (o BackupMapOutput) MapIndex(k pulumi.StringInput) BackupOutput
func (BackupMapOutput) ToBackupMapOutput ¶
func (o BackupMapOutput) ToBackupMapOutput() BackupMapOutput
func (BackupMapOutput) ToBackupMapOutputWithContext ¶
func (o BackupMapOutput) ToBackupMapOutputWithContext(ctx context.Context) BackupMapOutput
type BackupOutput ¶
type BackupOutput struct{ *pulumi.OutputState }
func (BackupOutput) CapacityGb ¶
func (o BackupOutput) CapacityGb() pulumi.StringOutput
The amount of bytes needed to allocate a full copy of the snapshot content.
func (BackupOutput) CreateTime ¶
func (o BackupOutput) CreateTime() pulumi.StringOutput
The time when the snapshot was created in RFC3339 text format.
func (BackupOutput) Description ¶
func (o BackupOutput) Description() pulumi.StringPtrOutput
A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
func (BackupOutput) DownloadBytes ¶
func (o BackupOutput) DownloadBytes() pulumi.StringOutput
Amount of bytes that will be downloaded if the backup is restored.
func (BackupOutput) EffectiveLabels ¶
func (o BackupOutput) EffectiveLabels() pulumi.StringMapOutput
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
func (BackupOutput) ElementType ¶
func (BackupOutput) ElementType() reflect.Type
func (BackupOutput) KmsKeyName ¶
func (o BackupOutput) KmsKeyName() pulumi.StringOutput
KMS key name used for data encryption.
func (BackupOutput) Labels ¶
func (o BackupOutput) Labels() pulumi.StringMapOutput
Resource labels to represent user-provided metadata.
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effectiveLabels` for all of the labels present on the resource.
func (BackupOutput) Location ¶
func (o BackupOutput) Location() pulumi.StringOutput
The name of the location of the instance. This can be a region for ENTERPRISE tier instances.
***
func (BackupOutput) Name ¶
func (o BackupOutput) Name() pulumi.StringOutput
The resource name of the backup. The name must be unique within the specified instance. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
func (BackupOutput) Project ¶
func (o BackupOutput) Project() pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (BackupOutput) PulumiLabels ¶
func (o BackupOutput) PulumiLabels() pulumi.StringMapOutput
The combination of labels configured directly on the resource and default labels configured on the provider.
func (BackupOutput) SourceFileShare ¶
func (o BackupOutput) SourceFileShare() pulumi.StringOutput
Name of the file share in the source Cloud Filestore instance that the backup is created from.
func (BackupOutput) SourceInstance ¶
func (o BackupOutput) SourceInstance() pulumi.StringOutput
The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup.
func (BackupOutput) SourceInstanceTier ¶
func (o BackupOutput) SourceInstanceTier() pulumi.StringOutput
The service tier of the source Cloud Filestore instance that this backup is created from.
func (BackupOutput) StorageBytes ¶
func (o BackupOutput) StorageBytes() pulumi.StringOutput
The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
func (BackupOutput) ToBackupOutput ¶
func (o BackupOutput) ToBackupOutput() BackupOutput
func (BackupOutput) ToBackupOutputWithContext ¶
func (o BackupOutput) ToBackupOutputWithContext(ctx context.Context) BackupOutput
type BackupState ¶
type BackupState struct { // The amount of bytes needed to allocate a full copy of the snapshot content. CapacityGb pulumi.StringPtrInput // The time when the snapshot was created in RFC3339 text format. CreateTime pulumi.StringPtrInput // A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrInput // Amount of bytes that will be downloaded if the backup is restored. DownloadBytes pulumi.StringPtrInput // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapInput // KMS key name used for data encryption. KmsKeyName pulumi.StringPtrInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. // // *** Location pulumi.StringPtrInput // The resource name of the backup. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapInput SourceFileShare pulumi.StringPtrInput // The resource name of the source Cloud Filestore instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}, used to create this backup. SourceInstance pulumi.StringPtrInput // The service tier of the source Cloud Filestore instance that this backup is created from. SourceInstanceTier pulumi.StringPtrInput // The backup state. State pulumi.StringPtrInput // The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. StorageBytes pulumi.StringPtrInput }
func (BackupState) ElementType ¶
func (BackupState) ElementType() reflect.Type
type Instance ¶
type Instance struct { pulumi.CustomResourceState // Creation timestamp in RFC3339 text format. CreateTime pulumi.StringOutput `pulumi:"createTime"` // A description of the instance. Description pulumi.StringPtrOutput `pulumi:"description"` // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapOutput `pulumi:"effectiveLabels"` // Server-specified ETag for the instance resource to prevent // simultaneous updates from overwriting each other. Etag pulumi.StringOutput `pulumi:"etag"` // single file share is supported. // Structure is documented below. FileShares InstanceFileSharesOutput `pulumi:"fileShares"` // KMS key name used for data encryption. KmsKeyName pulumi.StringPtrOutput `pulumi:"kmsKeyName"` // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapOutput `pulumi:"labels"` // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringOutput `pulumi:"location"` // The resource name of the instance. Name pulumi.StringOutput `pulumi:"name"` // VPC networks to which the instance is connected. For this version, // only a single network is supported. // Structure is documented below. Networks InstanceNetworkArrayOutput `pulumi:"networks"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapOutput `pulumi:"pulumiLabels"` // The service tier of the instance. // Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL, REGIONAL and ENTERPRISE Tier pulumi.StringOutput `pulumi:"tier"` // (Optional, Deprecated) // The name of the Filestore zone of the instance. // // > **Warning:** `zone` is deprecated and will be removed in a future major release. Use `location` instead. // // Deprecated: `zone` is deprecated and will be removed in a future major release. Use `location` instead. Zone pulumi.StringOutput `pulumi:"zone"` }
A Google Cloud Filestore instance.
To get more information about Instance, see:
* [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1beta1/projects.locations.instances/create) * How-to Guides
- [Official Documentation](https://cloud.google.com/filestore/docs/creating-instances)
- [Use with Kubernetes](https://cloud.google.com/filestore/docs/accessing-fileshares)
- [Copying Data In/Out](https://cloud.google.com/filestore/docs/copying-data)
## Example Usage ### Filestore Instance Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(1024), Name: pulumi.String("share1"), }, Location: pulumi.String("us-central1-b"), Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, Network: pulumi.String("default"), }, }, Tier: pulumi.String("BASIC_HDD"), }) if err != nil { return err } return nil }) }
``` ### Filestore Instance Full
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(2560), Name: pulumi.String("share1"), NfsExportOptions: filestore.InstanceFileSharesNfsExportOptionArray{ &filestore.InstanceFileSharesNfsExportOptionArgs{ AccessMode: pulumi.String("READ_WRITE"), IpRanges: pulumi.StringArray{ pulumi.String("10.0.0.0/24"), }, SquashMode: pulumi.String("NO_ROOT_SQUASH"), }, &filestore.InstanceFileSharesNfsExportOptionArgs{ AccessMode: pulumi.String("READ_ONLY"), AnonGid: pulumi.Int(456), AnonUid: pulumi.Int(123), IpRanges: pulumi.StringArray{ pulumi.String("10.10.0.0/24"), }, SquashMode: pulumi.String("ROOT_SQUASH"), }, }, }, Location: pulumi.String("us-central1-b"), Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ ConnectMode: pulumi.String("DIRECT_PEERING"), Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, Network: pulumi.String("default"), }, }, Tier: pulumi.String("BASIC_SSD"), }) if err != nil { return err } return nil }) }
``` ### Filestore Instance Enterprise
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { filestoreKeyring, err := kms.NewKeyRing(ctx, "filestoreKeyring", &kms.KeyRingArgs{ Location: pulumi.String("us-central1"), }) if err != nil { return err } filestoreKey, err := kms.NewCryptoKey(ctx, "filestoreKey", &kms.CryptoKeyArgs{ KeyRing: filestoreKeyring.ID(), }) if err != nil { return err } _, err = filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ Location: pulumi.String("us-central1"), Tier: pulumi.String("ENTERPRISE"), FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(1024), Name: pulumi.String("share1"), }, Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ Network: pulumi.String("default"), Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, }, }, KmsKeyName: filestoreKey.ID(), }) if err != nil { return err } return nil }) }
```
## Import
Instance can be imported using any of these accepted formats* `projects/{{project}}/locations/{{location}}/instances/{{name}}` * `{{project}}/{{location}}/{{name}}` * `{{location}}/{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Instance using one of the formats above. For exampletf import {
id = "projects/{{project}}/locations/{{location}}/instances/{{name}}" to = google_filestore_instance.default }
```sh
$ pulumi import gcp:filestore/instance:Instance When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Instance can be imported using one of the formats above. For example
```
```sh
$ pulumi import gcp:filestore/instance:Instance default projects/{{project}}/locations/{{location}}/instances/{{name}}
```
```sh
$ pulumi import gcp:filestore/instance:Instance default {{project}}/{{location}}/{{name}}
```
```sh
$ pulumi import gcp:filestore/instance:Instance default {{location}}/{{name}}
```
func GetInstance ¶
func GetInstance(ctx *pulumi.Context, name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)
GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewInstance ¶
func NewInstance(ctx *pulumi.Context, name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)
NewInstance registers a new resource with the given unique name, arguments, and options.
func (*Instance) ElementType ¶
func (*Instance) ToInstanceOutput ¶
func (i *Instance) ToInstanceOutput() InstanceOutput
func (*Instance) ToInstanceOutputWithContext ¶
func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
type InstanceArgs ¶
type InstanceArgs struct { // A description of the instance. Description pulumi.StringPtrInput // single file share is supported. // Structure is documented below. FileShares InstanceFileSharesInput // KMS key name used for data encryption. KmsKeyName pulumi.StringPtrInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringPtrInput // The resource name of the instance. Name pulumi.StringPtrInput // VPC networks to which the instance is connected. For this version, // only a single network is supported. // Structure is documented below. Networks InstanceNetworkArrayInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput // The service tier of the instance. // Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL, REGIONAL and ENTERPRISE Tier pulumi.StringInput // (Optional, Deprecated) // The name of the Filestore zone of the instance. // // > **Warning:** `zone` is deprecated and will be removed in a future major release. Use `location` instead. // // Deprecated: `zone` is deprecated and will be removed in a future major release. Use `location` instead. Zone pulumi.StringPtrInput }
The set of arguments for constructing a Instance resource.
func (InstanceArgs) ElementType ¶
func (InstanceArgs) ElementType() reflect.Type
type InstanceArray ¶
type InstanceArray []InstanceInput
func (InstanceArray) ElementType ¶
func (InstanceArray) ElementType() reflect.Type
func (InstanceArray) ToInstanceArrayOutput ¶
func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput
func (InstanceArray) ToInstanceArrayOutputWithContext ¶
func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput
type InstanceArrayInput ¶
type InstanceArrayInput interface { pulumi.Input ToInstanceArrayOutput() InstanceArrayOutput ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput }
InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via:
InstanceArray{ InstanceArgs{...} }
type InstanceArrayOutput ¶
type InstanceArrayOutput struct{ *pulumi.OutputState }
func (InstanceArrayOutput) ElementType ¶
func (InstanceArrayOutput) ElementType() reflect.Type
func (InstanceArrayOutput) Index ¶
func (o InstanceArrayOutput) Index(i pulumi.IntInput) InstanceOutput
func (InstanceArrayOutput) ToInstanceArrayOutput ¶
func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput
func (InstanceArrayOutput) ToInstanceArrayOutputWithContext ¶
func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput
type InstanceFileShares ¶
type InstanceFileShares struct { // for the standard tier, or 2560 GiB for the premium tier. CapacityGb int `pulumi:"capacityGb"` Name string `pulumi:"name"` // Structure is documented below. NfsExportOptions []InstanceFileSharesNfsExportOption `pulumi:"nfsExportOptions"` // The resource name of the backup, in the format // projects/{projectId}/locations/{locationId}/backups/{backupId}, // that this file share has been restored from. SourceBackup *string `pulumi:"sourceBackup"` }
type InstanceFileSharesArgs ¶
type InstanceFileSharesArgs struct { // for the standard tier, or 2560 GiB for the premium tier. CapacityGb pulumi.IntInput `pulumi:"capacityGb"` Name pulumi.StringInput `pulumi:"name"` // Structure is documented below. NfsExportOptions InstanceFileSharesNfsExportOptionArrayInput `pulumi:"nfsExportOptions"` // The resource name of the backup, in the format // projects/{projectId}/locations/{locationId}/backups/{backupId}, // that this file share has been restored from. SourceBackup pulumi.StringPtrInput `pulumi:"sourceBackup"` }
func (InstanceFileSharesArgs) ElementType ¶
func (InstanceFileSharesArgs) ElementType() reflect.Type
func (InstanceFileSharesArgs) ToInstanceFileSharesOutput ¶
func (i InstanceFileSharesArgs) ToInstanceFileSharesOutput() InstanceFileSharesOutput
func (InstanceFileSharesArgs) ToInstanceFileSharesOutputWithContext ¶
func (i InstanceFileSharesArgs) ToInstanceFileSharesOutputWithContext(ctx context.Context) InstanceFileSharesOutput
func (InstanceFileSharesArgs) ToInstanceFileSharesPtrOutput ¶
func (i InstanceFileSharesArgs) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
func (InstanceFileSharesArgs) ToInstanceFileSharesPtrOutputWithContext ¶
func (i InstanceFileSharesArgs) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
type InstanceFileSharesInput ¶
InstanceFileSharesInput is an input type that accepts InstanceFileSharesArgs and InstanceFileSharesOutput values. You can construct a concrete instance of `InstanceFileSharesInput` via:
InstanceFileSharesArgs{...}
type InstanceFileSharesNfsExportOption ¶
type InstanceFileSharesNfsExportOption struct { // or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. // Default value is `READ_WRITE`. // Possible values are: `READ_ONLY`, `READ_WRITE`. AccessMode *string `pulumi:"accessMode"` // Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned // if this field is specified for other squashMode settings. AnonGid *int `pulumi:"anonGid"` // Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned // if this field is specified for other squashMode settings. AnonUid *int `pulumi:"anonUid"` // Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. // The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. IpRanges []string `pulumi:"ipRanges"` // for not allowing root access. The default is NO_ROOT_SQUASH. // Default value is `NO_ROOT_SQUASH`. // Possible values are: `NO_ROOT_SQUASH`, `ROOT_SQUASH`. SquashMode *string `pulumi:"squashMode"` }
type InstanceFileSharesNfsExportOptionArgs ¶
type InstanceFileSharesNfsExportOptionArgs struct { // or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. // Default value is `READ_WRITE`. // Possible values are: `READ_ONLY`, `READ_WRITE`. AccessMode pulumi.StringPtrInput `pulumi:"accessMode"` // Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned // if this field is specified for other squashMode settings. AnonGid pulumi.IntPtrInput `pulumi:"anonGid"` // Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned // if this field is specified for other squashMode settings. AnonUid pulumi.IntPtrInput `pulumi:"anonUid"` // Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. // The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. IpRanges pulumi.StringArrayInput `pulumi:"ipRanges"` // for not allowing root access. The default is NO_ROOT_SQUASH. // Default value is `NO_ROOT_SQUASH`. // Possible values are: `NO_ROOT_SQUASH`, `ROOT_SQUASH`. SquashMode pulumi.StringPtrInput `pulumi:"squashMode"` }
func (InstanceFileSharesNfsExportOptionArgs) ElementType ¶
func (InstanceFileSharesNfsExportOptionArgs) ElementType() reflect.Type
func (InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutput ¶
func (i InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutput() InstanceFileSharesNfsExportOptionOutput
func (InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutputWithContext ¶
func (i InstanceFileSharesNfsExportOptionArgs) ToInstanceFileSharesNfsExportOptionOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionOutput
type InstanceFileSharesNfsExportOptionArray ¶
type InstanceFileSharesNfsExportOptionArray []InstanceFileSharesNfsExportOptionInput
func (InstanceFileSharesNfsExportOptionArray) ElementType ¶
func (InstanceFileSharesNfsExportOptionArray) ElementType() reflect.Type
func (InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutput ¶
func (i InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutput() InstanceFileSharesNfsExportOptionArrayOutput
func (InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext ¶
func (i InstanceFileSharesNfsExportOptionArray) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionArrayOutput
type InstanceFileSharesNfsExportOptionArrayInput ¶
InstanceFileSharesNfsExportOptionArrayInput is an input type that accepts InstanceFileSharesNfsExportOptionArray and InstanceFileSharesNfsExportOptionArrayOutput values. You can construct a concrete instance of `InstanceFileSharesNfsExportOptionArrayInput` via:
InstanceFileSharesNfsExportOptionArray{ InstanceFileSharesNfsExportOptionArgs{...} }
type InstanceFileSharesNfsExportOptionArrayOutput ¶
func (InstanceFileSharesNfsExportOptionArrayOutput) ElementType ¶
func (InstanceFileSharesNfsExportOptionArrayOutput) ElementType() reflect.Type
func (InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutput ¶
func (o InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutput() InstanceFileSharesNfsExportOptionArrayOutput
func (InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext ¶
func (o InstanceFileSharesNfsExportOptionArrayOutput) ToInstanceFileSharesNfsExportOptionArrayOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionArrayOutput
type InstanceFileSharesNfsExportOptionInput ¶
InstanceFileSharesNfsExportOptionInput is an input type that accepts InstanceFileSharesNfsExportOptionArgs and InstanceFileSharesNfsExportOptionOutput values. You can construct a concrete instance of `InstanceFileSharesNfsExportOptionInput` via:
InstanceFileSharesNfsExportOptionArgs{...}
type InstanceFileSharesNfsExportOptionOutput ¶
func (InstanceFileSharesNfsExportOptionOutput) AccessMode ¶
func (o InstanceFileSharesNfsExportOptionOutput) AccessMode() pulumi.StringPtrOutput
Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Default value is `READ_WRITE`. Possible values are: `READ_ONLY`, `READ_WRITE`.
func (InstanceFileSharesNfsExportOptionOutput) AnonGid ¶
func (o InstanceFileSharesNfsExportOptionOutput) AnonGid() pulumi.IntPtrOutput
An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
func (InstanceFileSharesNfsExportOptionOutput) AnonUid ¶
func (o InstanceFileSharesNfsExportOptionOutput) AnonUid() pulumi.IntPtrOutput
An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings.
func (InstanceFileSharesNfsExportOptionOutput) ElementType ¶
func (InstanceFileSharesNfsExportOptionOutput) ElementType() reflect.Type
func (InstanceFileSharesNfsExportOptionOutput) IpRanges ¶
func (o InstanceFileSharesNfsExportOptionOutput) IpRanges() pulumi.StringArrayOutput
List of either IPv4 addresses, or ranges in CIDR notation which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
func (InstanceFileSharesNfsExportOptionOutput) SquashMode ¶
func (o InstanceFileSharesNfsExportOptionOutput) SquashMode() pulumi.StringPtrOutput
Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Default value is `NO_ROOT_SQUASH`. Possible values are: `NO_ROOT_SQUASH`, `ROOT_SQUASH`.
func (InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutput ¶
func (o InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutput() InstanceFileSharesNfsExportOptionOutput
func (InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutputWithContext ¶
func (o InstanceFileSharesNfsExportOptionOutput) ToInstanceFileSharesNfsExportOptionOutputWithContext(ctx context.Context) InstanceFileSharesNfsExportOptionOutput
type InstanceFileSharesOutput ¶
func (InstanceFileSharesOutput) CapacityGb ¶
func (o InstanceFileSharesOutput) CapacityGb() pulumi.IntOutput
File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
func (InstanceFileSharesOutput) ElementType ¶
func (InstanceFileSharesOutput) ElementType() reflect.Type
func (InstanceFileSharesOutput) Name ¶
func (o InstanceFileSharesOutput) Name() pulumi.StringOutput
The name of the fileshare (16 characters or less)
func (InstanceFileSharesOutput) NfsExportOptions ¶
func (o InstanceFileSharesOutput) NfsExportOptions() InstanceFileSharesNfsExportOptionArrayOutput
Nfs Export Options. There is a limit of 10 export options per file share. Structure is documented below.
func (InstanceFileSharesOutput) SourceBackup ¶
func (o InstanceFileSharesOutput) SourceBackup() pulumi.StringPtrOutput
(Output) The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.
func (InstanceFileSharesOutput) ToInstanceFileSharesOutput ¶
func (o InstanceFileSharesOutput) ToInstanceFileSharesOutput() InstanceFileSharesOutput
func (InstanceFileSharesOutput) ToInstanceFileSharesOutputWithContext ¶
func (o InstanceFileSharesOutput) ToInstanceFileSharesOutputWithContext(ctx context.Context) InstanceFileSharesOutput
func (InstanceFileSharesOutput) ToInstanceFileSharesPtrOutput ¶
func (o InstanceFileSharesOutput) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
func (InstanceFileSharesOutput) ToInstanceFileSharesPtrOutputWithContext ¶
func (o InstanceFileSharesOutput) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
type InstanceFileSharesPtrInput ¶
InstanceFileSharesPtrInput is an input type that accepts InstanceFileSharesArgs, InstanceFileSharesPtr and InstanceFileSharesPtrOutput values. You can construct a concrete instance of `InstanceFileSharesPtrInput` via:
InstanceFileSharesArgs{...} or: nil
func InstanceFileSharesPtr ¶
func InstanceFileSharesPtr(v *InstanceFileSharesArgs) InstanceFileSharesPtrInput
type InstanceFileSharesPtrOutput ¶
func (InstanceFileSharesPtrOutput) CapacityGb ¶
func (o InstanceFileSharesPtrOutput) CapacityGb() pulumi.IntPtrOutput
File share capacity in GiB. This must be at least 1024 GiB for the standard tier, or 2560 GiB for the premium tier.
func (InstanceFileSharesPtrOutput) Elem ¶
func (o InstanceFileSharesPtrOutput) Elem() InstanceFileSharesOutput
func (InstanceFileSharesPtrOutput) ElementType ¶
func (InstanceFileSharesPtrOutput) ElementType() reflect.Type
func (InstanceFileSharesPtrOutput) Name ¶
func (o InstanceFileSharesPtrOutput) Name() pulumi.StringPtrOutput
The name of the fileshare (16 characters or less)
func (InstanceFileSharesPtrOutput) NfsExportOptions ¶
func (o InstanceFileSharesPtrOutput) NfsExportOptions() InstanceFileSharesNfsExportOptionArrayOutput
Nfs Export Options. There is a limit of 10 export options per file share. Structure is documented below.
func (InstanceFileSharesPtrOutput) SourceBackup ¶
func (o InstanceFileSharesPtrOutput) SourceBackup() pulumi.StringPtrOutput
(Output) The resource name of the backup, in the format projects/{projectId}/locations/{locationId}/backups/{backupId}, that this file share has been restored from.
func (InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutput ¶
func (o InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutput() InstanceFileSharesPtrOutput
func (InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutputWithContext ¶
func (o InstanceFileSharesPtrOutput) ToInstanceFileSharesPtrOutputWithContext(ctx context.Context) InstanceFileSharesPtrOutput
type InstanceInput ¶
type InstanceInput interface { pulumi.Input ToInstanceOutput() InstanceOutput ToInstanceOutputWithContext(ctx context.Context) InstanceOutput }
type InstanceMap ¶
type InstanceMap map[string]InstanceInput
func (InstanceMap) ElementType ¶
func (InstanceMap) ElementType() reflect.Type
func (InstanceMap) ToInstanceMapOutput ¶
func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput
func (InstanceMap) ToInstanceMapOutputWithContext ¶
func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput
type InstanceMapInput ¶
type InstanceMapInput interface { pulumi.Input ToInstanceMapOutput() InstanceMapOutput ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput }
InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via:
InstanceMap{ "key": InstanceArgs{...} }
type InstanceMapOutput ¶
type InstanceMapOutput struct{ *pulumi.OutputState }
func (InstanceMapOutput) ElementType ¶
func (InstanceMapOutput) ElementType() reflect.Type
func (InstanceMapOutput) MapIndex ¶
func (o InstanceMapOutput) MapIndex(k pulumi.StringInput) InstanceOutput
func (InstanceMapOutput) ToInstanceMapOutput ¶
func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput
func (InstanceMapOutput) ToInstanceMapOutputWithContext ¶
func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput
type InstanceNetwork ¶
type InstanceNetwork struct { // The network connect mode of the Filestore instance. // If not provided, the connect mode defaults to // DIRECT_PEERING. // Default value is `DIRECT_PEERING`. // Possible values are: `DIRECT_PEERING`, `PRIVATE_SERVICE_ACCESS`. // // *** ConnectMode *string `pulumi:"connectMode"` // (Output) // A list of IPv4 or IPv6 addresses. IpAddresses []string `pulumi:"ipAddresses"` // IP versions for which the instance has // IP addresses assigned. // Each value may be one of: `ADDRESS_MODE_UNSPECIFIED`, `MODE_IPV4`, `MODE_IPV6`. Modes []string `pulumi:"modes"` // The name of the GCE VPC network to which the // instance is connected. Network string `pulumi:"network"` // A /29 CIDR block that identifies the range of IP // addresses reserved for this instance. ReservedIpRange *string `pulumi:"reservedIpRange"` }
type InstanceNetworkArgs ¶
type InstanceNetworkArgs struct { // The network connect mode of the Filestore instance. // If not provided, the connect mode defaults to // DIRECT_PEERING. // Default value is `DIRECT_PEERING`. // Possible values are: `DIRECT_PEERING`, `PRIVATE_SERVICE_ACCESS`. // // *** ConnectMode pulumi.StringPtrInput `pulumi:"connectMode"` // (Output) // A list of IPv4 or IPv6 addresses. IpAddresses pulumi.StringArrayInput `pulumi:"ipAddresses"` // IP versions for which the instance has // IP addresses assigned. // Each value may be one of: `ADDRESS_MODE_UNSPECIFIED`, `MODE_IPV4`, `MODE_IPV6`. Modes pulumi.StringArrayInput `pulumi:"modes"` // The name of the GCE VPC network to which the // instance is connected. Network pulumi.StringInput `pulumi:"network"` // A /29 CIDR block that identifies the range of IP // addresses reserved for this instance. ReservedIpRange pulumi.StringPtrInput `pulumi:"reservedIpRange"` }
func (InstanceNetworkArgs) ElementType ¶
func (InstanceNetworkArgs) ElementType() reflect.Type
func (InstanceNetworkArgs) ToInstanceNetworkOutput ¶
func (i InstanceNetworkArgs) ToInstanceNetworkOutput() InstanceNetworkOutput
func (InstanceNetworkArgs) ToInstanceNetworkOutputWithContext ¶
func (i InstanceNetworkArgs) ToInstanceNetworkOutputWithContext(ctx context.Context) InstanceNetworkOutput
type InstanceNetworkArray ¶
type InstanceNetworkArray []InstanceNetworkInput
func (InstanceNetworkArray) ElementType ¶
func (InstanceNetworkArray) ElementType() reflect.Type
func (InstanceNetworkArray) ToInstanceNetworkArrayOutput ¶
func (i InstanceNetworkArray) ToInstanceNetworkArrayOutput() InstanceNetworkArrayOutput
func (InstanceNetworkArray) ToInstanceNetworkArrayOutputWithContext ¶
func (i InstanceNetworkArray) ToInstanceNetworkArrayOutputWithContext(ctx context.Context) InstanceNetworkArrayOutput
type InstanceNetworkArrayInput ¶
type InstanceNetworkArrayInput interface { pulumi.Input ToInstanceNetworkArrayOutput() InstanceNetworkArrayOutput ToInstanceNetworkArrayOutputWithContext(context.Context) InstanceNetworkArrayOutput }
InstanceNetworkArrayInput is an input type that accepts InstanceNetworkArray and InstanceNetworkArrayOutput values. You can construct a concrete instance of `InstanceNetworkArrayInput` via:
InstanceNetworkArray{ InstanceNetworkArgs{...} }
type InstanceNetworkArrayOutput ¶
type InstanceNetworkArrayOutput struct{ *pulumi.OutputState }
func (InstanceNetworkArrayOutput) ElementType ¶
func (InstanceNetworkArrayOutput) ElementType() reflect.Type
func (InstanceNetworkArrayOutput) Index ¶
func (o InstanceNetworkArrayOutput) Index(i pulumi.IntInput) InstanceNetworkOutput
func (InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutput ¶
func (o InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutput() InstanceNetworkArrayOutput
func (InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutputWithContext ¶
func (o InstanceNetworkArrayOutput) ToInstanceNetworkArrayOutputWithContext(ctx context.Context) InstanceNetworkArrayOutput
type InstanceNetworkInput ¶
type InstanceNetworkInput interface { pulumi.Input ToInstanceNetworkOutput() InstanceNetworkOutput ToInstanceNetworkOutputWithContext(context.Context) InstanceNetworkOutput }
InstanceNetworkInput is an input type that accepts InstanceNetworkArgs and InstanceNetworkOutput values. You can construct a concrete instance of `InstanceNetworkInput` via:
InstanceNetworkArgs{...}
type InstanceNetworkOutput ¶
type InstanceNetworkOutput struct{ *pulumi.OutputState }
func (InstanceNetworkOutput) ConnectMode ¶
func (o InstanceNetworkOutput) ConnectMode() pulumi.StringPtrOutput
The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. Default value is `DIRECT_PEERING`. Possible values are: `DIRECT_PEERING`, `PRIVATE_SERVICE_ACCESS`.
***
func (InstanceNetworkOutput) ElementType ¶
func (InstanceNetworkOutput) ElementType() reflect.Type
func (InstanceNetworkOutput) IpAddresses ¶
func (o InstanceNetworkOutput) IpAddresses() pulumi.StringArrayOutput
(Output) A list of IPv4 or IPv6 addresses.
func (InstanceNetworkOutput) Modes ¶
func (o InstanceNetworkOutput) Modes() pulumi.StringArrayOutput
IP versions for which the instance has IP addresses assigned. Each value may be one of: `ADDRESS_MODE_UNSPECIFIED`, `MODE_IPV4`, `MODE_IPV6`.
func (InstanceNetworkOutput) Network ¶
func (o InstanceNetworkOutput) Network() pulumi.StringOutput
The name of the GCE VPC network to which the instance is connected.
func (InstanceNetworkOutput) ReservedIpRange ¶
func (o InstanceNetworkOutput) ReservedIpRange() pulumi.StringPtrOutput
A /29 CIDR block that identifies the range of IP addresses reserved for this instance.
func (InstanceNetworkOutput) ToInstanceNetworkOutput ¶
func (o InstanceNetworkOutput) ToInstanceNetworkOutput() InstanceNetworkOutput
func (InstanceNetworkOutput) ToInstanceNetworkOutputWithContext ¶
func (o InstanceNetworkOutput) ToInstanceNetworkOutputWithContext(ctx context.Context) InstanceNetworkOutput
type InstanceOutput ¶
type InstanceOutput struct{ *pulumi.OutputState }
func (InstanceOutput) CreateTime ¶
func (o InstanceOutput) CreateTime() pulumi.StringOutput
Creation timestamp in RFC3339 text format.
func (InstanceOutput) Description ¶
func (o InstanceOutput) Description() pulumi.StringPtrOutput
A description of the instance.
func (InstanceOutput) EffectiveLabels ¶
func (o InstanceOutput) EffectiveLabels() pulumi.StringMapOutput
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
func (InstanceOutput) ElementType ¶
func (InstanceOutput) ElementType() reflect.Type
func (InstanceOutput) Etag ¶
func (o InstanceOutput) Etag() pulumi.StringOutput
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
func (InstanceOutput) FileShares ¶
func (o InstanceOutput) FileShares() InstanceFileSharesOutput
File system shares on the instance. For this version, only a single file share is supported. Structure is documented below.
func (InstanceOutput) KmsKeyName ¶
func (o InstanceOutput) KmsKeyName() pulumi.StringPtrOutput
KMS key name used for data encryption.
func (InstanceOutput) Labels ¶
func (o InstanceOutput) Labels() pulumi.StringMapOutput
Resource labels to represent user-provided metadata.
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effectiveLabels` for all of the labels present on the resource.
func (InstanceOutput) Location ¶
func (o InstanceOutput) Location() pulumi.StringOutput
The name of the location of the instance. This can be a region for ENTERPRISE tier instances.
func (InstanceOutput) Name ¶
func (o InstanceOutput) Name() pulumi.StringOutput
The resource name of the instance.
func (InstanceOutput) Networks ¶
func (o InstanceOutput) Networks() InstanceNetworkArrayOutput
VPC networks to which the instance is connected. For this version, only a single network is supported. Structure is documented below.
func (InstanceOutput) Project ¶
func (o InstanceOutput) Project() pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (InstanceOutput) PulumiLabels ¶
func (o InstanceOutput) PulumiLabels() pulumi.StringMapOutput
The combination of labels configured directly on the resource and default labels configured on the provider.
func (InstanceOutput) Tier ¶
func (o InstanceOutput) Tier() pulumi.StringOutput
The service tier of the instance. Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL, REGIONAL and ENTERPRISE
func (InstanceOutput) ToInstanceOutput ¶
func (o InstanceOutput) ToInstanceOutput() InstanceOutput
func (InstanceOutput) ToInstanceOutputWithContext ¶
func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
func (InstanceOutput) Zone
deprecated
func (o InstanceOutput) Zone() pulumi.StringOutput
(Optional, Deprecated) The name of the Filestore zone of the instance.
> **Warning:** `zone` is deprecated and will be removed in a future major release. Use `location` instead.
Deprecated: `zone` is deprecated and will be removed in a future major release. Use `location` instead.
type InstanceState ¶
type InstanceState struct { // Creation timestamp in RFC3339 text format. CreateTime pulumi.StringPtrInput // A description of the instance. Description pulumi.StringPtrInput // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapInput // Server-specified ETag for the instance resource to prevent // simultaneous updates from overwriting each other. Etag pulumi.StringPtrInput // single file share is supported. // Structure is documented below. FileShares InstanceFileSharesPtrInput // KMS key name used for data encryption. KmsKeyName pulumi.StringPtrInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringPtrInput // The resource name of the instance. Name pulumi.StringPtrInput // VPC networks to which the instance is connected. For this version, // only a single network is supported. // Structure is documented below. Networks InstanceNetworkArrayInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapInput // The service tier of the instance. // Possible values include: STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD, ZONAL, REGIONAL and ENTERPRISE Tier pulumi.StringPtrInput // (Optional, Deprecated) // The name of the Filestore zone of the instance. // // > **Warning:** `zone` is deprecated and will be removed in a future major release. Use `location` instead. // // Deprecated: `zone` is deprecated and will be removed in a future major release. Use `location` instead. Zone pulumi.StringPtrInput }
func (InstanceState) ElementType ¶
func (InstanceState) ElementType() reflect.Type
type Snapshot ¶
type Snapshot struct { pulumi.CustomResourceState // The time when the snapshot was created in RFC3339 text format. CreateTime pulumi.StringOutput `pulumi:"createTime"` // A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrOutput `pulumi:"description"` // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapOutput `pulumi:"effectiveLabels"` // The amount of bytes needed to allocate a full copy of the snapshot content. FilesystemUsedBytes pulumi.StringOutput `pulumi:"filesystemUsedBytes"` // The resource name of the filestore instance. // // *** Instance pulumi.StringOutput `pulumi:"instance"` // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapOutput `pulumi:"labels"` // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringOutput `pulumi:"location"` // The resource name of the snapshot. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringOutput `pulumi:"name"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapOutput `pulumi:"pulumiLabels"` // The snapshot state. State pulumi.StringOutput `pulumi:"state"` }
A Google Cloud Filestore snapshot.
To get more information about Snapshot, see:
* [API documentation](https://cloud.google.com/filestore/docs/reference/rest/v1/projects.locations.instances.snapshots) * How-to Guides
- [Official Documentation](https://cloud.google.com/filestore/docs/snapshots)
- [Creating Snapshots](https://cloud.google.com/filestore/docs/create-snapshots)
## Example Usage ### Filestore Snapshot Basic
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ Location: pulumi.String("us-east1"), Tier: pulumi.String("ENTERPRISE"), FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(1024), Name: pulumi.String("share1"), }, Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ Network: pulumi.String("default"), Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, }, }, }) if err != nil { return err } _, err = filestore.NewSnapshot(ctx, "snapshot", &filestore.SnapshotArgs{ Instance: instance.Name, Location: pulumi.String("us-east1"), }) if err != nil { return err } return nil }) }
``` ### Filestore Snapshot Full
```go package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/filestore" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { instance, err := filestore.NewInstance(ctx, "instance", &filestore.InstanceArgs{ Location: pulumi.String("us-west1"), Tier: pulumi.String("ENTERPRISE"), FileShares: &filestore.InstanceFileSharesArgs{ CapacityGb: pulumi.Int(1024), Name: pulumi.String("share1"), }, Networks: filestore.InstanceNetworkArray{ &filestore.InstanceNetworkArgs{ Network: pulumi.String("default"), Modes: pulumi.StringArray{ pulumi.String("MODE_IPV4"), }, }, }, }) if err != nil { return err } _, err = filestore.NewSnapshot(ctx, "snapshot", &filestore.SnapshotArgs{ Instance: instance.Name, Location: pulumi.String("us-west1"), Description: pulumi.String("Snapshot of test-instance-for-snapshot"), Labels: pulumi.StringMap{ "my_label": pulumi.String("value"), }, }) if err != nil { return err } return nil }) }
```
## Import
Snapshot can be imported using any of these accepted formats* `projects/{{project}}/locations/{{location}}/instances/{{instance}}/snapshots/{{name}}` * `{{project}}/{{location}}/{{instance}}/{{name}}` * `{{location}}/{{instance}}/{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Snapshot using one of the formats above. For exampletf import {
id = "projects/{{project}}/locations/{{location}}/instances/{{instance}}/snapshots/{{name}}" to = google_filestore_snapshot.default }
```sh
$ pulumi import gcp:filestore/snapshot:Snapshot When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Snapshot can be imported using one of the formats above. For example
```
```sh
$ pulumi import gcp:filestore/snapshot:Snapshot default projects/{{project}}/locations/{{location}}/instances/{{instance}}/snapshots/{{name}}
```
```sh
$ pulumi import gcp:filestore/snapshot:Snapshot default {{project}}/{{location}}/{{instance}}/{{name}}
```
```sh
$ pulumi import gcp:filestore/snapshot:Snapshot default {{location}}/{{instance}}/{{name}}
```
func GetSnapshot ¶
func GetSnapshot(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SnapshotState, opts ...pulumi.ResourceOption) (*Snapshot, error)
GetSnapshot gets an existing Snapshot resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSnapshot ¶
func NewSnapshot(ctx *pulumi.Context, name string, args *SnapshotArgs, opts ...pulumi.ResourceOption) (*Snapshot, error)
NewSnapshot registers a new resource with the given unique name, arguments, and options.
func (*Snapshot) ElementType ¶
func (*Snapshot) ToSnapshotOutput ¶
func (i *Snapshot) ToSnapshotOutput() SnapshotOutput
func (*Snapshot) ToSnapshotOutputWithContext ¶
func (i *Snapshot) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
type SnapshotArgs ¶
type SnapshotArgs struct { // A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrInput // The resource name of the filestore instance. // // *** Instance pulumi.StringInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringInput // The resource name of the snapshot. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
The set of arguments for constructing a Snapshot resource.
func (SnapshotArgs) ElementType ¶
func (SnapshotArgs) ElementType() reflect.Type
type SnapshotArray ¶
type SnapshotArray []SnapshotInput
func (SnapshotArray) ElementType ¶
func (SnapshotArray) ElementType() reflect.Type
func (SnapshotArray) ToSnapshotArrayOutput ¶
func (i SnapshotArray) ToSnapshotArrayOutput() SnapshotArrayOutput
func (SnapshotArray) ToSnapshotArrayOutputWithContext ¶
func (i SnapshotArray) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput
type SnapshotArrayInput ¶
type SnapshotArrayInput interface { pulumi.Input ToSnapshotArrayOutput() SnapshotArrayOutput ToSnapshotArrayOutputWithContext(context.Context) SnapshotArrayOutput }
SnapshotArrayInput is an input type that accepts SnapshotArray and SnapshotArrayOutput values. You can construct a concrete instance of `SnapshotArrayInput` via:
SnapshotArray{ SnapshotArgs{...} }
type SnapshotArrayOutput ¶
type SnapshotArrayOutput struct{ *pulumi.OutputState }
func (SnapshotArrayOutput) ElementType ¶
func (SnapshotArrayOutput) ElementType() reflect.Type
func (SnapshotArrayOutput) Index ¶
func (o SnapshotArrayOutput) Index(i pulumi.IntInput) SnapshotOutput
func (SnapshotArrayOutput) ToSnapshotArrayOutput ¶
func (o SnapshotArrayOutput) ToSnapshotArrayOutput() SnapshotArrayOutput
func (SnapshotArrayOutput) ToSnapshotArrayOutputWithContext ¶
func (o SnapshotArrayOutput) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput
type SnapshotInput ¶
type SnapshotInput interface { pulumi.Input ToSnapshotOutput() SnapshotOutput ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput }
type SnapshotMap ¶
type SnapshotMap map[string]SnapshotInput
func (SnapshotMap) ElementType ¶
func (SnapshotMap) ElementType() reflect.Type
func (SnapshotMap) ToSnapshotMapOutput ¶
func (i SnapshotMap) ToSnapshotMapOutput() SnapshotMapOutput
func (SnapshotMap) ToSnapshotMapOutputWithContext ¶
func (i SnapshotMap) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput
type SnapshotMapInput ¶
type SnapshotMapInput interface { pulumi.Input ToSnapshotMapOutput() SnapshotMapOutput ToSnapshotMapOutputWithContext(context.Context) SnapshotMapOutput }
SnapshotMapInput is an input type that accepts SnapshotMap and SnapshotMapOutput values. You can construct a concrete instance of `SnapshotMapInput` via:
SnapshotMap{ "key": SnapshotArgs{...} }
type SnapshotMapOutput ¶
type SnapshotMapOutput struct{ *pulumi.OutputState }
func (SnapshotMapOutput) ElementType ¶
func (SnapshotMapOutput) ElementType() reflect.Type
func (SnapshotMapOutput) MapIndex ¶
func (o SnapshotMapOutput) MapIndex(k pulumi.StringInput) SnapshotOutput
func (SnapshotMapOutput) ToSnapshotMapOutput ¶
func (o SnapshotMapOutput) ToSnapshotMapOutput() SnapshotMapOutput
func (SnapshotMapOutput) ToSnapshotMapOutputWithContext ¶
func (o SnapshotMapOutput) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput
type SnapshotOutput ¶
type SnapshotOutput struct{ *pulumi.OutputState }
func (SnapshotOutput) CreateTime ¶
func (o SnapshotOutput) CreateTime() pulumi.StringOutput
The time when the snapshot was created in RFC3339 text format.
func (SnapshotOutput) Description ¶
func (o SnapshotOutput) Description() pulumi.StringPtrOutput
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
func (SnapshotOutput) EffectiveLabels ¶
func (o SnapshotOutput) EffectiveLabels() pulumi.StringMapOutput
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
func (SnapshotOutput) ElementType ¶
func (SnapshotOutput) ElementType() reflect.Type
func (SnapshotOutput) FilesystemUsedBytes ¶
func (o SnapshotOutput) FilesystemUsedBytes() pulumi.StringOutput
The amount of bytes needed to allocate a full copy of the snapshot content.
func (SnapshotOutput) Instance ¶
func (o SnapshotOutput) Instance() pulumi.StringOutput
The resource name of the filestore instance.
***
func (SnapshotOutput) Labels ¶
func (o SnapshotOutput) Labels() pulumi.StringMapOutput
Resource labels to represent user-provided metadata.
**Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field `effectiveLabels` for all of the labels present on the resource.
func (SnapshotOutput) Location ¶
func (o SnapshotOutput) Location() pulumi.StringOutput
The name of the location of the instance. This can be a region for ENTERPRISE tier instances.
func (SnapshotOutput) Name ¶
func (o SnapshotOutput) Name() pulumi.StringOutput
The resource name of the snapshot. The name must be unique within the specified instance. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `a-z?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
func (SnapshotOutput) Project ¶
func (o SnapshotOutput) Project() pulumi.StringOutput
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
func (SnapshotOutput) PulumiLabels ¶
func (o SnapshotOutput) PulumiLabels() pulumi.StringMapOutput
The combination of labels configured directly on the resource and default labels configured on the provider.
func (SnapshotOutput) State ¶
func (o SnapshotOutput) State() pulumi.StringOutput
The snapshot state.
func (SnapshotOutput) ToSnapshotOutput ¶
func (o SnapshotOutput) ToSnapshotOutput() SnapshotOutput
func (SnapshotOutput) ToSnapshotOutputWithContext ¶
func (o SnapshotOutput) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
type SnapshotState ¶
type SnapshotState struct { // The time when the snapshot was created in RFC3339 text format. CreateTime pulumi.StringPtrInput // A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. Description pulumi.StringPtrInput // All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. EffectiveLabels pulumi.StringMapInput // The amount of bytes needed to allocate a full copy of the snapshot content. FilesystemUsedBytes pulumi.StringPtrInput // The resource name of the filestore instance. // // *** Instance pulumi.StringPtrInput // Resource labels to represent user-provided metadata. // // **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. // Please refer to the field `effectiveLabels` for all of the labels present on the resource. Labels pulumi.StringMapInput // The name of the location of the instance. This can be a region for ENTERPRISE tier instances. Location pulumi.StringPtrInput // The resource name of the snapshot. The name must be unique within the specified instance. // The name must be 1-63 characters long, and comply with // RFC1035. Specifically, the name must be 1-63 characters long and match // the regular expression `a-z?` which means the // first character must be a lowercase letter, and all following // characters must be a dash, lowercase letter, or digit, except the last // character, which cannot be a dash. Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput // The combination of labels configured directly on the resource // and default labels configured on the provider. PulumiLabels pulumi.StringMapInput // The snapshot state. State pulumi.StringPtrInput }
func (SnapshotState) ElementType ¶
func (SnapshotState) ElementType() reflect.Type