Docs Packages
  1. Packages
  2. Exoscale
  3. API Docs
  4. BlockStorageVolumeSnapshot
Exoscale v0.59.0 published on Monday, May 20, 2024 by Pulumiverse
pulumiverse/pulumi-exoscale

exoscale.BlockStorageVolumeSnapshot

Explore with Pulumi AI

exoscale logo
Exoscale v0.59.0 published on Monday, May 20, 2024 by Pulumiverse
pulumiverse/pulumi-exoscale

    Manage Exoscale Block Storage Volume Snapshot.

    Block Storage offers persistent externally attached volumes for your workloads.

    Create BlockStorageVolumeSnapshot Resource

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

    Constructor syntax

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

@overload
def BlockStorageVolumeSnapshot(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               volume: Optional[BlockStorageVolumeSnapshotVolumeArgs] = None,
                               zone: Optional[str] = None,
                               labels: Optional[Mapping[str, str]] = None,
                               name: Optional[str] = None,
                               timeouts: Optional[BlockStorageVolumeSnapshotTimeoutsArgs] = None)
    func NewBlockStorageVolumeSnapshot(ctx *Context, name string, args BlockStorageVolumeSnapshotArgs, opts ...ResourceOption) (*BlockStorageVolumeSnapshot, error)
    public BlockStorageVolumeSnapshot(string name, BlockStorageVolumeSnapshotArgs args, CustomResourceOptions? opts = null)
    public BlockStorageVolumeSnapshot(String name, BlockStorageVolumeSnapshotArgs args)
public BlockStorageVolumeSnapshot(String name, BlockStorageVolumeSnapshotArgs args, CustomResourceOptions options)

    type: exoscale:BlockStorageVolumeSnapshot
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 BlockStorageVolumeSnapshotArgs
    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 BlockStorageVolumeSnapshotArgs
    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 BlockStorageVolumeSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlockStorageVolumeSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlockStorageVolumeSnapshotArgs
    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 blockStorageVolumeSnapshotResource = new Exoscale.BlockStorageVolumeSnapshot("blockStorageVolumeSnapshotResource", new()
{
    Volume = new Exoscale.Inputs.BlockStorageVolumeSnapshotVolumeArgs
    {
        Id = "string",
    },
    Zone = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Timeouts = new Exoscale.Inputs.BlockStorageVolumeSnapshotTimeoutsArgs
    {
        Read = "string",
    },
});

    example, err := exoscale.NewBlockStorageVolumeSnapshot(ctx, "blockStorageVolumeSnapshotResource", &exoscale.BlockStorageVolumeSnapshotArgs{
	Volume: &exoscale.BlockStorageVolumeSnapshotVolumeArgs{
		Id: pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Timeouts: &exoscale.BlockStorageVolumeSnapshotTimeoutsArgs{
		Read: pulumi.String("string"),
	},
})

    var blockStorageVolumeSnapshotResource = new BlockStorageVolumeSnapshot("blockStorageVolumeSnapshotResource", BlockStorageVolumeSnapshotArgs.builder()
    .volume(BlockStorageVolumeSnapshotVolumeArgs.builder()
        .id("string")
        .build())
    .zone("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .timeouts(BlockStorageVolumeSnapshotTimeoutsArgs.builder()
        .read("string")
        .build())
    .build());

    block_storage_volume_snapshot_resource = exoscale.BlockStorageVolumeSnapshot("blockStorageVolumeSnapshotResource",
    volume=exoscale.BlockStorageVolumeSnapshotVolumeArgs(
        id="string",
    ),
    zone="string",
    labels={
        "string": "string",
    },
    name="string",
    timeouts=exoscale.BlockStorageVolumeSnapshotTimeoutsArgs(
        read="string",
    ))

    const blockStorageVolumeSnapshotResource = new exoscale.BlockStorageVolumeSnapshot("blockStorageVolumeSnapshotResource", {
    volume: {
        id: "string",
    },
    zone: "string",
    labels: {
        string: "string",
    },
    name: "string",
    timeouts: {
        read: "string",
    },
});

    type: exoscale:BlockStorageVolumeSnapshot
properties:
    labels:
        string: string
    name: string
    timeouts:
        read: string
    volume:
        id: string
    zone: string

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

    Volume Pulumiverse.Exoscale.Inputs.BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    Zone string
    ❗ The Exoscale Zone name.
    Labels Dictionary<string, string>
    Resource labels.
    Name string
    Volume snapshot name.
    Timeouts Pulumiverse.Exoscale.Inputs.BlockStorageVolumeSnapshotTimeouts
    Volume BlockStorageVolumeSnapshotVolumeArgs
    Volume from which to create a snapshot.
    Zone string
    ❗ The Exoscale Zone name.
    Labels map[string]string
    Resource labels.
    Name string
    Volume snapshot name.
    Timeouts BlockStorageVolumeSnapshotTimeoutsArgs
    volume BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    zone String
    ❗ The Exoscale Zone name.
    labels Map<String,String>
    Resource labels.
    name String
    Volume snapshot name.
    timeouts BlockStorageVolumeSnapshotTimeouts
    volume BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    zone string
    ❗ The Exoscale Zone name.
    labels {[key: string]: string}
    Resource labels.
    name string
    Volume snapshot name.
    timeouts BlockStorageVolumeSnapshotTimeouts
    volume BlockStorageVolumeSnapshotVolumeArgs
    Volume from which to create a snapshot.
    zone str
    ❗ The Exoscale Zone name.
    labels Mapping[str, str]
    Resource labels.
    name str
    Volume snapshot name.
    timeouts BlockStorageVolumeSnapshotTimeoutsArgs
    volume Property Map
    Volume from which to create a snapshot.
    zone String
    ❗ The Exoscale Zone name.
    labels Map<String>
    Resource labels.
    name String
    Volume snapshot name.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    Snapshot creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    Snapshot size in GB.
    State string
    Snapshot state.
    CreatedAt string
    Snapshot creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    Snapshot size in GB.
    State string
    Snapshot state.
    createdAt String
    Snapshot creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    size Integer
    Snapshot size in GB.
    state String
    Snapshot state.
    createdAt string
    Snapshot creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    Snapshot size in GB.
    state string
    Snapshot state.
    created_at str
    Snapshot creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    size int
    Snapshot size in GB.
    state str
    Snapshot state.
    createdAt String
    Snapshot creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    size Number
    Snapshot size in GB.
    state String
    Snapshot state.

    Look up Existing BlockStorageVolumeSnapshot Resource

    Get an existing BlockStorageVolumeSnapshot 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?: BlockStorageVolumeSnapshotState, opts?: CustomResourceOptions): BlockStorageVolumeSnapshot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        size: Optional[int] = None,
        state: Optional[str] = None,
        timeouts: Optional[BlockStorageVolumeSnapshotTimeoutsArgs] = None,
        volume: Optional[BlockStorageVolumeSnapshotVolumeArgs] = None,
        zone: Optional[str] = None) -> BlockStorageVolumeSnapshot
    func GetBlockStorageVolumeSnapshot(ctx *Context, name string, id IDInput, state *BlockStorageVolumeSnapshotState, opts ...ResourceOption) (*BlockStorageVolumeSnapshot, error)
    public static BlockStorageVolumeSnapshot Get(string name, Input<string> id, BlockStorageVolumeSnapshotState? state, CustomResourceOptions? opts = null)
    public static BlockStorageVolumeSnapshot get(String name, Output<String> id, BlockStorageVolumeSnapshotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CreatedAt string
    Snapshot creation date.
    Labels Dictionary<string, string>
    Resource labels.
    Name string
    Volume snapshot name.
    Size int
    Snapshot size in GB.
    State string
    Snapshot state.
    Timeouts Pulumiverse.Exoscale.Inputs.BlockStorageVolumeSnapshotTimeouts
    Volume Pulumiverse.Exoscale.Inputs.BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    Zone string
    ❗ The Exoscale Zone name.
    CreatedAt string
    Snapshot creation date.
    Labels map[string]string
    Resource labels.
    Name string
    Volume snapshot name.
    Size int
    Snapshot size in GB.
    State string
    Snapshot state.
    Timeouts BlockStorageVolumeSnapshotTimeoutsArgs
    Volume BlockStorageVolumeSnapshotVolumeArgs
    Volume from which to create a snapshot.
    Zone string
    ❗ The Exoscale Zone name.
    createdAt String
    Snapshot creation date.
    labels Map<String,String>
    Resource labels.
    name String
    Volume snapshot name.
    size Integer
    Snapshot size in GB.
    state String
    Snapshot state.
    timeouts BlockStorageVolumeSnapshotTimeouts
    volume BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    zone String
    ❗ The Exoscale Zone name.
    createdAt string
    Snapshot creation date.
    labels {[key: string]: string}
    Resource labels.
    name string
    Volume snapshot name.
    size number
    Snapshot size in GB.
    state string
    Snapshot state.
    timeouts BlockStorageVolumeSnapshotTimeouts
    volume BlockStorageVolumeSnapshotVolume
    Volume from which to create a snapshot.
    zone string
    ❗ The Exoscale Zone name.
    created_at str
    Snapshot creation date.
    labels Mapping[str, str]
    Resource labels.
    name str
    Volume snapshot name.
    size int
    Snapshot size in GB.
    state str
    Snapshot state.
    timeouts BlockStorageVolumeSnapshotTimeoutsArgs
    volume BlockStorageVolumeSnapshotVolumeArgs
    Volume from which to create a snapshot.
    zone str
    ❗ The Exoscale Zone name.
    createdAt String
    Snapshot creation date.
    labels Map<String>
    Resource labels.
    name String
    Volume snapshot name.
    size Number
    Snapshot size in GB.
    state String
    Snapshot state.
    timeouts Property Map
    volume Property Map
    Volume from which to create a snapshot.
    zone String
    ❗ The Exoscale Zone name.

    Supporting Types

    BlockStorageVolumeSnapshotTimeouts, BlockStorageVolumeSnapshotTimeoutsArgs

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

    BlockStorageVolumeSnapshotVolume, BlockStorageVolumeSnapshotVolumeArgs

    Id string
    Snapshot ID.
    Id string
    Snapshot ID.
    id String
    Snapshot ID.
    id string
    Snapshot ID.
    id str
    Snapshot ID.
    id String
    Snapshot ID.

    Package Details

    Repository
    exoscale pulumiverse/pulumi-exoscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the exoscale Terraform Provider.
    exoscale logo
    Exoscale v0.59.0 published on Monday, May 20, 2024 by Pulumiverse
    pulumiverse/pulumi-exoscale