Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. file
  5. file/v1beta1
  6. Snapshot

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.file/v1beta1.Snapshot

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a snapshot. Auto-naming is currently not supported for this resource.

Create Snapshot Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);
@overload
def Snapshot(resource_name: str,
             args: SnapshotArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_id: Optional[str] = None,
             snapshot_id: Optional[str] = None,
             description: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             location: Optional[str] = None,
             project: Optional[str] = None)
func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

type: google-native:file/v1beta1:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SnapshotArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var examplesnapshotResourceResourceFromFilev1beta1 = new GoogleNative.File.V1Beta1.Snapshot("examplesnapshotResourceResourceFromFilev1beta1", new()
{
    InstanceId = "string",
    SnapshotId = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Project = "string",
});
Copy
example, err := filev1beta1.NewSnapshot(ctx, "examplesnapshotResourceResourceFromFilev1beta1", &filev1beta1.SnapshotArgs{
	InstanceId:  pulumi.String("string"),
	SnapshotId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var examplesnapshotResourceResourceFromFilev1beta1 = new Snapshot("examplesnapshotResourceResourceFromFilev1beta1", SnapshotArgs.builder()
    .instanceId("string")
    .snapshotId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .project("string")
    .build());
Copy
examplesnapshot_resource_resource_from_filev1beta1 = google_native.file.v1beta1.Snapshot("examplesnapshotResourceResourceFromFilev1beta1",
    instance_id="string",
    snapshot_id="string",
    description="string",
    labels={
        "string": "string",
    },
    location="string",
    project="string")
Copy
const examplesnapshotResourceResourceFromFilev1beta1 = new google_native.file.v1beta1.Snapshot("examplesnapshotResourceResourceFromFilev1beta1", {
    instanceId: "string",
    snapshotId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    location: "string",
    project: "string",
});
Copy
type: google-native:file/v1beta1:Snapshot
properties:
    description: string
    instanceId: string
    labels:
        string: string
    location: string
    project: string
    snapshotId: string
Copy

Snapshot Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Snapshot resource accepts the following input properties:

InstanceId
This property is required.
Changes to this property will trigger replacement.
string
SnapshotId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
Description string
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
Labels Dictionary<string, string>
Resource labels to represent user provided metadata.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
SnapshotId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
Description string
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
Labels map[string]string
Resource labels to represent user provided metadata.
Location Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. string
instanceId
This property is required.
Changes to this property will trigger replacement.
String
snapshotId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
description String
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Map<String,String>
Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String
instanceId
This property is required.
Changes to this property will trigger replacement.
string
snapshotId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
description string
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
labels {[key: string]: string}
Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. string
instance_id
This property is required.
Changes to this property will trigger replacement.
str
snapshot_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
description str
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Mapping[str, str]
Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. str
instanceId
This property is required.
Changes to this property will trigger replacement.
String
snapshotId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the snapshot. The ID must be unique within the specified instance. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
description String
A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected.
labels Map<String>
Resource labels to represent user provided metadata.
location Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. String

Outputs

All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

CreateTime string
The time when the snapshot was created.
FilesystemUsedBytes string
The amount of bytes needed to allocate a full copy of the snapshot content
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
State string
The snapshot state.
CreateTime string
The time when the snapshot was created.
FilesystemUsedBytes string
The amount of bytes needed to allocate a full copy of the snapshot content
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
State string
The snapshot state.
createTime String
The time when the snapshot was created.
filesystemUsedBytes String
The amount of bytes needed to allocate a full copy of the snapshot content
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
state String
The snapshot state.
createTime string
The time when the snapshot was created.
filesystemUsedBytes string
The amount of bytes needed to allocate a full copy of the snapshot content
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
state string
The snapshot state.
create_time str
The time when the snapshot was created.
filesystem_used_bytes str
The amount of bytes needed to allocate a full copy of the snapshot content
id str
The provider-assigned unique ID for this managed resource.
name str
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
state str
The snapshot state.
createTime String
The time when the snapshot was created.
filesystemUsedBytes String
The amount of bytes needed to allocate a full copy of the snapshot content
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}.
state String
The snapshot state.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native