1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/beta
  6. InstantSnapshot

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

google-native.compute/beta.InstantSnapshot

Explore with Pulumi AI

google-native logo

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

    Creates an instant snapshot in the specified zone.

    Create InstantSnapshot Resource

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

    Constructor syntax

    new InstantSnapshot(name: string, args?: InstantSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def InstantSnapshot(resource_name: str,
                        args: Optional[InstantSnapshotArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def InstantSnapshot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        name: Optional[str] = None,
                        project: Optional[str] = None,
                        request_id: Optional[str] = None,
                        source_disk: Optional[str] = None,
                        zone: Optional[str] = None)
    func NewInstantSnapshot(ctx *Context, name string, args *InstantSnapshotArgs, opts ...ResourceOption) (*InstantSnapshot, error)
    public InstantSnapshot(string name, InstantSnapshotArgs? args = null, CustomResourceOptions? opts = null)
    public InstantSnapshot(String name, InstantSnapshotArgs args)
    public InstantSnapshot(String name, InstantSnapshotArgs args, CustomResourceOptions options)
    
    type: google-native:compute/beta:InstantSnapshot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var google_nativeInstantSnapshotResource = new GoogleNative.Compute.Beta.InstantSnapshot("google-nativeInstantSnapshotResource", new()
    {
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Project = "string",
        RequestId = "string",
        SourceDisk = "string",
        Zone = "string",
    });
    
    example, err := computebeta.NewInstantSnapshot(ctx, "google-nativeInstantSnapshotResource", &computebeta.InstantSnapshotArgs{
    Description: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Name: pulumi.String("string"),
    Project: pulumi.String("string"),
    RequestId: pulumi.String("string"),
    SourceDisk: pulumi.String("string"),
    Zone: pulumi.String("string"),
    })
    
    var google_nativeInstantSnapshotResource = new InstantSnapshot("google-nativeInstantSnapshotResource", InstantSnapshotArgs.builder()
        .description("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .project("string")
        .requestId("string")
        .sourceDisk("string")
        .zone("string")
        .build());
    
    google_native_instant_snapshot_resource = google_native.compute.beta.InstantSnapshot("google-nativeInstantSnapshotResource",
        description="string",
        labels={
            "string": "string",
        },
        name="string",
        project="string",
        request_id="string",
        source_disk="string",
        zone="string")
    
    const google_nativeInstantSnapshotResource = new google_native.compute.beta.InstantSnapshot("google-nativeInstantSnapshotResource", {
        description: "string",
        labels: {
            string: "string",
        },
        name: "string",
        project: "string",
        requestId: "string",
        sourceDisk: "string",
        zone: "string",
    });
    
    type: google-native:compute/beta:InstantSnapshot
    properties:
        description: string
        labels:
            string: string
        name: string
        project: string
        requestId: string
        sourceDisk: string
        zone: string
    

    InstantSnapshot Resource Properties

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

    Inputs

    The InstantSnapshot resource accepts the following input properties:

    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Labels Dictionary<string, string>
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    Name string
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    Project string
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    SourceDisk string
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    Zone string
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Labels map[string]string
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    Name string
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    Project string
    RequestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    SourceDisk string
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    Zone string
    description String
    An optional description of this resource. Provide this property when you create the resource.
    labels Map<String,String>
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    name String
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    project String
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    sourceDisk String
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    zone String
    description string
    An optional description of this resource. Provide this property when you create the resource.
    labels {[key: string]: string}
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    name string
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    project string
    requestId string
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    sourceDisk string
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    zone string
    description str
    An optional description of this resource. Provide this property when you create the resource.
    labels Mapping[str, str]
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    name str
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    project str
    request_id str
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    source_disk str
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    zone str
    description String
    An optional description of this resource. Provide this property when you create the resource.
    labels Map<String>
    Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.
    name String
    Name of the resource; provided by the client when the resource is created. 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]([-a-z0-9]*[a-z0-9])? 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.
    project String
    requestId String
    An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
    sourceDisk String
    URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
    zone String

    Outputs

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

    Architecture string
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    DiskSizeGb string
    Size of the source disk, specified in GB.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    LabelFingerprint string
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    Region string
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    ResourceStatus Pulumi.GoogleNative.Compute.Beta.Outputs.InstantSnapshotResourceStatusResponse
    Status information for the instant snapshot resource.
    SatisfiesPzs bool
    Reserved for future use.
    SelfLink string
    Server-defined URL for the resource.
    SelfLinkWithId string
    Server-defined URL for this resource's resource id.
    SourceDiskId string
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    Status string
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
    Architecture string
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    DiskSizeGb string
    Size of the source disk, specified in GB.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    LabelFingerprint string
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    Region string
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    ResourceStatus InstantSnapshotResourceStatusResponse
    Status information for the instant snapshot resource.
    SatisfiesPzs bool
    Reserved for future use.
    SelfLink string
    Server-defined URL for the resource.
    SelfLinkWithId string
    Server-defined URL for this resource's resource id.
    SourceDiskId string
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    Status string
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
    architecture String
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    diskSizeGb String
    Size of the source disk, specified in GB.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    labelFingerprint String
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    region String
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    resourceStatus InstantSnapshotResourceStatusResponse
    Status information for the instant snapshot resource.
    satisfiesPzs Boolean
    Reserved for future use.
    selfLink String
    Server-defined URL for the resource.
    selfLinkWithId String
    Server-defined URL for this resource's resource id.
    sourceDiskId String
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    status String
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
    architecture string
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    diskSizeGb string
    Size of the source disk, specified in GB.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    labelFingerprint string
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    region string
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    resourceStatus InstantSnapshotResourceStatusResponse
    Status information for the instant snapshot resource.
    satisfiesPzs boolean
    Reserved for future use.
    selfLink string
    Server-defined URL for the resource.
    selfLinkWithId string
    Server-defined URL for this resource's resource id.
    sourceDiskId string
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    status string
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
    architecture str
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    disk_size_gb str
    Size of the source disk, specified in GB.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    label_fingerprint str
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    region str
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    resource_status InstantSnapshotResourceStatusResponse
    Status information for the instant snapshot resource.
    satisfies_pzs bool
    Reserved for future use.
    self_link str
    Server-defined URL for the resource.
    self_link_with_id str
    Server-defined URL for this resource's resource id.
    source_disk_id str
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    status str
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.
    architecture String
    The architecture of the instant snapshot. Valid values are ARM64 or X86_64.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    diskSizeGb String
    Size of the source disk, specified in GB.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.
    labelFingerprint String
    A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.
    region String
    URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
    resourceStatus Property Map
    Status information for the instant snapshot resource.
    satisfiesPzs Boolean
    Reserved for future use.
    selfLink String
    Server-defined URL for the resource.
    selfLinkWithId String
    Server-defined URL for this resource's resource id.
    sourceDiskId String
    The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.
    status String
    The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.

    Supporting Types

    InstantSnapshotResourceStatusResponse, InstantSnapshotResourceStatusResponseArgs

    StorageSizeBytes string
    The storage size of this instant snapshot.
    StorageSizeBytes string
    The storage size of this instant snapshot.
    storageSizeBytes String
    The storage size of this instant snapshot.
    storageSizeBytes string
    The storage size of this instant snapshot.
    storage_size_bytes str
    The storage size of this instant snapshot.
    storageSizeBytes String
    The storage size of this instant snapshot.

    Package Details

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

    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