1. Packages
  2. Vra Provider
  3. API Docs
  4. BlockDeviceSnapshot
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

vra.BlockDeviceSnapshot

Explore with Pulumi AI

vra logo
vra 0.12.0 published on Monday, Apr 14, 2025 by vmware

    Creates a VMware vRealize Automation block device snapshot resource.

    Example Usage

    S

    The following example shows how to create a block device snapshot resource.

    import * as pulumi from "@pulumi/pulumi";
    import * as vra from "@pulumi/vra";
    
    const snapshot1 = new vra.BlockDeviceSnapshot("snapshot1", {
        blockDeviceId: _var.block_device_id,
        description: "terraform fcd snapshot",
    });
    
    import pulumi
    import pulumi_vra as vra
    
    snapshot1 = vra.BlockDeviceSnapshot("snapshot1",
        block_device_id=var["block_device_id"],
        description="terraform fcd snapshot")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vra.NewBlockDeviceSnapshot(ctx, "snapshot1", &vra.BlockDeviceSnapshotArgs{
    			BlockDeviceId: pulumi.Any(_var.Block_device_id),
    			Description:   pulumi.String("terraform fcd snapshot"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vra = Pulumi.Vra;
    
    return await Deployment.RunAsync(() => 
    {
        var snapshot1 = new Vra.BlockDeviceSnapshot("snapshot1", new()
        {
            BlockDeviceId = @var.Block_device_id,
            Description = "terraform fcd snapshot",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vra.BlockDeviceSnapshot;
    import com.pulumi.vra.BlockDeviceSnapshotArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var snapshot1 = new BlockDeviceSnapshot("snapshot1", BlockDeviceSnapshotArgs.builder()
                .blockDeviceId(var_.block_device_id())
                .description("terraform fcd snapshot")
                .build());
    
        }
    }
    
    resources:
      snapshot1:
        type: vra:BlockDeviceSnapshot
        properties:
          blockDeviceId: ${var.block_device_id}
          description: terraform fcd snapshot
    

    Create BlockDeviceSnapshot Resource

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

    Constructor syntax

    new BlockDeviceSnapshot(name: string, args: BlockDeviceSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def BlockDeviceSnapshot(resource_name: str,
                            args: BlockDeviceSnapshotInitArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def BlockDeviceSnapshot(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            block_device_id: Optional[str] = None,
                            block_device_snapshot_id: Optional[str] = None,
                            description: Optional[str] = None,
                            timeouts: Optional[BlockDeviceSnapshotTimeoutsArgs] = None)
    func NewBlockDeviceSnapshot(ctx *Context, name string, args BlockDeviceSnapshotArgs, opts ...ResourceOption) (*BlockDeviceSnapshot, error)
    public BlockDeviceSnapshot(string name, BlockDeviceSnapshotArgs args, CustomResourceOptions? opts = null)
    public BlockDeviceSnapshot(String name, BlockDeviceSnapshotArgs args)
    public BlockDeviceSnapshot(String name, BlockDeviceSnapshotArgs args, CustomResourceOptions options)
    
    type: vra:BlockDeviceSnapshot
    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 BlockDeviceSnapshotArgs
    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 BlockDeviceSnapshotInitArgs
    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 BlockDeviceSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlockDeviceSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlockDeviceSnapshotArgs
    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 blockDeviceSnapshotResource = new Vra.BlockDeviceSnapshot("blockDeviceSnapshotResource", new()
    {
        BlockDeviceId = "string",
        BlockDeviceSnapshotId = "string",
        Description = "string",
        Timeouts = new Vra.Inputs.BlockDeviceSnapshotTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := vra.NewBlockDeviceSnapshot(ctx, "blockDeviceSnapshotResource", &vra.BlockDeviceSnapshotArgs{
    	BlockDeviceId:         pulumi.String("string"),
    	BlockDeviceSnapshotId: pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	Timeouts: &vra.BlockDeviceSnapshotTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var blockDeviceSnapshotResource = new BlockDeviceSnapshot("blockDeviceSnapshotResource", BlockDeviceSnapshotArgs.builder()
        .blockDeviceId("string")
        .blockDeviceSnapshotId("string")
        .description("string")
        .timeouts(BlockDeviceSnapshotTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    block_device_snapshot_resource = vra.BlockDeviceSnapshot("blockDeviceSnapshotResource",
        block_device_id="string",
        block_device_snapshot_id="string",
        description="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const blockDeviceSnapshotResource = new vra.BlockDeviceSnapshot("blockDeviceSnapshotResource", {
        blockDeviceId: "string",
        blockDeviceSnapshotId: "string",
        description: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: vra:BlockDeviceSnapshot
    properties:
        blockDeviceId: string
        blockDeviceSnapshotId: string
        description: string
        timeouts:
            create: string
            delete: string
            update: string
    

    BlockDeviceSnapshot 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 BlockDeviceSnapshot resource accepts the following input properties:

    BlockDeviceId string
    ID of block device.
    BlockDeviceSnapshotId string
    Description string
    Human-friendly description.
    Timeouts BlockDeviceSnapshotTimeouts
    BlockDeviceId string
    ID of block device.
    BlockDeviceSnapshotId string
    Description string
    Human-friendly description.
    Timeouts BlockDeviceSnapshotTimeoutsArgs
    blockDeviceId String
    ID of block device.
    blockDeviceSnapshotId String
    description String
    Human-friendly description.
    timeouts BlockDeviceSnapshotTimeouts
    blockDeviceId string
    ID of block device.
    blockDeviceSnapshotId string
    description string
    Human-friendly description.
    timeouts BlockDeviceSnapshotTimeouts
    blockDeviceId String
    ID of block device.
    blockDeviceSnapshotId String
    description String
    Human-friendly description.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCurrent bool
    Indicates whether snapshot on block device is current.
    Links List<BlockDeviceSnapshotLink>
    HATEOAS of entity
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    ID of organization that entity belongs to.
    Owner string
    Email of entity owner.
    UpdatedAt string
    CreatedAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCurrent bool
    Indicates whether snapshot on block device is current.
    Links []BlockDeviceSnapshotLink
    HATEOAS of entity
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    ID of organization that entity belongs to.
    Owner string
    Email of entity owner.
    UpdatedAt string
    createdAt String
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    isCurrent Boolean
    Indicates whether snapshot on block device is current.
    links List<BlockDeviceSnapshotLink>
    HATEOAS of entity
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    orgId String
    ID of organization that entity belongs to.
    owner String
    Email of entity owner.
    updatedAt String
    createdAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    isCurrent boolean
    Indicates whether snapshot on block device is current.
    links BlockDeviceSnapshotLink[]
    HATEOAS of entity
    name string
    Human-friendly name used as an identifier in APIs that support this option.
    orgId string
    ID of organization that entity belongs to.
    owner string
    Email of entity owner.
    updatedAt string
    created_at str
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    id str
    The provider-assigned unique ID for this managed resource.
    is_current bool
    Indicates whether snapshot on block device is current.
    links Sequence[BlockDeviceSnapshotLink]
    HATEOAS of entity
    name str
    Human-friendly name used as an identifier in APIs that support this option.
    org_id str
    ID of organization that entity belongs to.
    owner str
    Email of entity owner.
    updated_at str
    createdAt String
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    isCurrent Boolean
    Indicates whether snapshot on block device is current.
    links List<Property Map>
    HATEOAS of entity
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    orgId String
    ID of organization that entity belongs to.
    owner String
    Email of entity owner.
    updatedAt String

    Look up Existing BlockDeviceSnapshot Resource

    Get an existing BlockDeviceSnapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BlockDeviceSnapshotState, opts?: CustomResourceOptions): BlockDeviceSnapshot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            block_device_id: Optional[str] = None,
            block_device_snapshot_id: Optional[str] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            is_current: Optional[bool] = None,
            links: Optional[Sequence[BlockDeviceSnapshotLinkArgs]] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            owner: Optional[str] = None,
            timeouts: Optional[BlockDeviceSnapshotTimeoutsArgs] = None,
            updated_at: Optional[str] = None) -> BlockDeviceSnapshot
    func GetBlockDeviceSnapshot(ctx *Context, name string, id IDInput, state *BlockDeviceSnapshotState, opts ...ResourceOption) (*BlockDeviceSnapshot, error)
    public static BlockDeviceSnapshot Get(string name, Input<string> id, BlockDeviceSnapshotState? state, CustomResourceOptions? opts = null)
    public static BlockDeviceSnapshot get(String name, Output<String> id, BlockDeviceSnapshotState state, CustomResourceOptions options)
    resources:  _:    type: vra:BlockDeviceSnapshot    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BlockDeviceId string
    ID of block device.
    BlockDeviceSnapshotId string
    CreatedAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    Description string
    Human-friendly description.
    IsCurrent bool
    Indicates whether snapshot on block device is current.
    Links List<BlockDeviceSnapshotLink>
    HATEOAS of entity
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    ID of organization that entity belongs to.
    Owner string
    Email of entity owner.
    Timeouts BlockDeviceSnapshotTimeouts
    UpdatedAt string
    BlockDeviceId string
    ID of block device.
    BlockDeviceSnapshotId string
    CreatedAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    Description string
    Human-friendly description.
    IsCurrent bool
    Indicates whether snapshot on block device is current.
    Links []BlockDeviceSnapshotLinkArgs
    HATEOAS of entity
    Name string
    Human-friendly name used as an identifier in APIs that support this option.
    OrgId string
    ID of organization that entity belongs to.
    Owner string
    Email of entity owner.
    Timeouts BlockDeviceSnapshotTimeoutsArgs
    UpdatedAt string
    blockDeviceId String
    ID of block device.
    blockDeviceSnapshotId String
    createdAt String
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    description String
    Human-friendly description.
    isCurrent Boolean
    Indicates whether snapshot on block device is current.
    links List<BlockDeviceSnapshotLink>
    HATEOAS of entity
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    orgId String
    ID of organization that entity belongs to.
    owner String
    Email of entity owner.
    timeouts BlockDeviceSnapshotTimeouts
    updatedAt String
    blockDeviceId string
    ID of block device.
    blockDeviceSnapshotId string
    createdAt string
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    description string
    Human-friendly description.
    isCurrent boolean
    Indicates whether snapshot on block device is current.
    links BlockDeviceSnapshotLink[]
    HATEOAS of entity
    name string
    Human-friendly name used as an identifier in APIs that support this option.
    orgId string
    ID of organization that entity belongs to.
    owner string
    Email of entity owner.
    timeouts BlockDeviceSnapshotTimeouts
    updatedAt string
    block_device_id str
    ID of block device.
    block_device_snapshot_id str
    created_at str
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    description str
    Human-friendly description.
    is_current bool
    Indicates whether snapshot on block device is current.
    links Sequence[BlockDeviceSnapshotLinkArgs]
    HATEOAS of entity
    name str
    Human-friendly name used as an identifier in APIs that support this option.
    org_id str
    ID of organization that entity belongs to.
    owner str
    Email of entity owner.
    timeouts BlockDeviceSnapshotTimeoutsArgs
    updated_at str
    blockDeviceId String
    ID of block device.
    blockDeviceSnapshotId String
    createdAt String
    Date when entity was created. Date and time format is ISO 8601 and UTC.
    description String
    Human-friendly description.
    isCurrent Boolean
    Indicates whether snapshot on block device is current.
    links List<Property Map>
    HATEOAS of entity
    name String
    Human-friendly name used as an identifier in APIs that support this option.
    orgId String
    ID of organization that entity belongs to.
    owner String
    Email of entity owner.
    timeouts Property Map
    updatedAt String

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    BlockDeviceSnapshotTimeouts, BlockDeviceSnapshotTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    vra 0.12.0 published on Monday, Apr 14, 2025 by vmware