1. Registry
  2. Packages
  3. Equinix Metal
  4. API Docs
  5. Volume

This package is deprecated. Equinix has shut down the Equinix Metal service.

Viewing docs for Equinix Metal v3.2.1
published on Thursday, Dec 30, 2021 by Pulumi
equinix-metal logo equinix-metal logo Equinix Metal

This package is deprecated. Equinix has shut down the Equinix Metal service.

Viewing docs for Equinix Metal v3.2.1
published on Thursday, Dec 30, 2021 by Pulumi

    Resource equinix-metal.Volume was removed in version 3.0.0, and the API support was deprecated on June 1st 2021. See https://metal.equinix.com/developers/docs/storage/elastic-block-storage/#elastic-block-storage for more details.

    Create Volume Resource

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

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
    def Volume(resource_name: str,
               args: VolumeArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Volume(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               facility: Optional[Union[str, Facility]] = None,
               plan: Optional[str] = None,
               project_id: Optional[str] = None,
               size: Optional[int] = None,
               billing_cycle: Optional[Union[str, BillingCycle]] = None,
               description: Optional[str] = None,
               locked: Optional[bool] = None,
               snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
    public Volume(String name, VolumeArgs args, CustomResourceOptions options)
    
    type: equinix-metal:Volume
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "equinix-metal_volume" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    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 VolumeArgs
    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 VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    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 volumeResource = new EquinixMetal.Volume("volumeResource", new()
    {
        Facility = "string",
        Plan = "string",
        ProjectId = "string",
        Size = 0,
        BillingCycle = "string",
        Description = "string",
        Locked = false,
        SnapshotPolicies = new[]
        {
            new EquinixMetal.Inputs.VolumeSnapshotPolicyArgs
            {
                SnapshotCount = 0,
                SnapshotFrequency = "string",
            },
        },
    });
    
    example, err := equinixmetal.NewVolume(ctx, "volumeResource", &equinixmetal.VolumeArgs{
    	Facility:     pulumi.String("string"),
    	Plan:         pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	Size:         pulumi.Int(0),
    	BillingCycle: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Locked:       pulumi.Bool(false),
    	SnapshotPolicies: equinix.VolumeSnapshotPolicyArray{
    		&equinix.VolumeSnapshotPolicyArgs{
    			SnapshotCount:     pulumi.Int(0),
    			SnapshotFrequency: pulumi.String("string"),
    		},
    	},
    })
    
    resource "equinix-metal_volume" "volumeResource" {
      lifecycle {
        create_before_destroy = true
      }
      facility      = "string"
      plan          = "string"
      project_id    = "string"
      size          = 0
      billing_cycle = "string"
      description   = "string"
      locked        = false
      snapshot_policies {
        snapshot_count     = 0
        snapshot_frequency = "string"
      }
    }
    
    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
        .facility("string")
        .plan("string")
        .projectId("string")
        .size(0)
        .billingCycle("string")
        .description("string")
        .locked(false)
        .snapshotPolicies(VolumeSnapshotPolicyArgs.builder()
            .snapshotCount(0)
            .snapshotFrequency("string")
            .build())
        .build());
    
    volume_resource = equinix_metal.Volume("volumeResource",
        facility="string",
        plan="string",
        project_id="string",
        size=0,
        billing_cycle="string",
        description="string",
        locked=False,
        snapshot_policies=[{
            "snapshot_count": 0,
            "snapshot_frequency": "string",
        }])
    
    const volumeResource = new equinix_metal.Volume("volumeResource", {
        facility: "string",
        plan: "string",
        projectId: "string",
        size: 0,
        billingCycle: "string",
        description: "string",
        locked: false,
        snapshotPolicies: [{
            snapshotCount: 0,
            snapshotFrequency: "string",
        }],
    });
    
    type: equinix-metal:Volume
    properties:
        billingCycle: string
        description: string
        facility: string
        locked: false
        plan: string
        projectId: string
        size: 0
        snapshotPolicies:
            - snapshotCount: 0
              snapshotFrequency: string
    

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

    Outputs

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

    Attachments List<Pulumi.EquinixMetal.Outputs.VolumeAttachment>
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    State string
    Updated string
    Attachments []VolumeAttachmentType
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    State string
    Updated string
    attachments list(object)
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    state string
    updated string
    attachments List<VolumeAttachment>
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    state String
    updated String
    attachments VolumeAttachment[]
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    state string
    updated string
    attachments Sequence[VolumeAttachment]
    created str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    state str
    updated str
    attachments List<Property Map>
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    state String
    updated String

    Look up Existing Volume Resource

    Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attachments: Optional[Sequence[VolumeAttachmentArgs]] = None,
            billing_cycle: Optional[Union[str, BillingCycle]] = None,
            created: Optional[str] = None,
            description: Optional[str] = None,
            facility: Optional[Union[str, Facility]] = None,
            locked: Optional[bool] = None,
            name: Optional[str] = None,
            plan: Optional[str] = None,
            project_id: Optional[str] = None,
            size: Optional[int] = None,
            snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None,
            state: Optional[str] = None,
            updated: Optional[str] = None) -> Volume
    func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
    public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
    public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
    resources:  existingVolume:    type: equinix-metal:Volume    get:      id: ${id}
    import {
      to = equinix-metal_volume.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state VolumeState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state VolumeState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state VolumeState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state VolumeState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:

    Supporting Types

    BillingCycle, BillingCycleArgs

    NameValue
    Hourlyhourly
    Monthlymonthly
    NameValue
    BillingCycleHourlyhourly
    BillingCycleMonthlymonthly
    Value
    hourly
    monthly
    NameValue
    Hourlyhourly
    Monthlymonthly
    NameValue
    Hourlyhourly
    Monthlymonthly
    NameValue
    HOURLYhourly
    MONTHLYmonthly
    Value
    hourly
    monthly

    Facility, FacilityArgs

    NameValue
    EWR1ewr1
    SJC1sjc1
    DFW1dfw1
    DFW2dfw2
    AMS1ams1
    NRT1nrt1
    SEA1sea1
    LAX1lax1
    ORD1ord1
    ATL1atl1
    IAD1iad1
    SIN1sin1
    HKG1hkg1
    SYD1syd1
    MRS1mrs1
    YYZ1yyz1
    FRA2fra2
    AM6am6
    DC13dc13
    CH3ch3
    DA3da3
    DA11da11
    LA4la4
    NY5ny5
    SG1sg1
    SV15sv15
    NameValue
    FacilityEWR1ewr1
    FacilitySJC1sjc1
    FacilityDFW1dfw1
    FacilityDFW2dfw2
    FacilityAMS1ams1
    FacilityNRT1nrt1
    FacilitySEA1sea1
    FacilityLAX1lax1
    FacilityORD1ord1
    FacilityATL1atl1
    FacilityIAD1iad1
    FacilitySIN1sin1
    FacilityHKG1hkg1
    FacilitySYD1syd1
    FacilityMRS1mrs1
    FacilityYYZ1yyz1
    FacilityFRA2fra2
    FacilityAM6am6
    FacilityDC13dc13
    FacilityCH3ch3
    FacilityDA3da3
    FacilityDA11da11
    FacilityLA4la4
    FacilityNY5ny5
    FacilitySG1sg1
    FacilitySV15sv15
    Value
    ewr1
    sjc1
    dfw1
    dfw2
    ams1
    nrt1
    sea1
    lax1
    ord1
    atl1
    iad1
    sin1
    hkg1
    syd1
    mrs1
    yyz1
    fra2
    am6
    dc13
    ch3
    da3
    da11
    la4
    ny5
    sg1
    sv15
    NameValue
    EWR1ewr1
    SJC1sjc1
    DFW1dfw1
    DFW2dfw2
    AMS1ams1
    NRT1nrt1
    SEA1sea1
    LAX1lax1
    ORD1ord1
    ATL1atl1
    IAD1iad1
    SIN1sin1
    HKG1hkg1
    SYD1syd1
    MRS1mrs1
    YYZ1yyz1
    FRA2fra2
    AM6am6
    DC13dc13
    CH3ch3
    DA3da3
    DA11da11
    LA4la4
    NY5ny5
    SG1sg1
    SV15sv15
    NameValue
    EWR1ewr1
    SJC1sjc1
    DFW1dfw1
    DFW2dfw2
    AMS1ams1
    NRT1nrt1
    SEA1sea1
    LAX1lax1
    ORD1ord1
    ATL1atl1
    IAD1iad1
    SIN1sin1
    HKG1hkg1
    SYD1syd1
    MRS1mrs1
    YYZ1yyz1
    FRA2fra2
    AM6am6
    DC13dc13
    CH3ch3
    DA3da3
    DA11da11
    LA4la4
    NY5ny5
    SG1sg1
    SV15sv15
    NameValue
    EWR1ewr1
    SJC1sjc1
    DFW1dfw1
    DFW2dfw2
    AMS1ams1
    NRT1nrt1
    SEA1sea1
    LAX1lax1
    ORD1ord1
    ATL1atl1
    IAD1iad1
    SIN1sin1
    HKG1hkg1
    SYD1syd1
    MRS1mrs1
    YYZ1yyz1
    FRA2fra2
    AM6am6
    DC13dc13
    CH3ch3
    DA3da3
    DA11da11
    LA4la4
    NY5ny5
    SG1sg1
    SV15sv15
    Value
    ewr1
    sjc1
    dfw1
    dfw2
    ams1
    nrt1
    sea1
    lax1
    ord1
    atl1
    iad1
    sin1
    hkg1
    syd1
    mrs1
    yyz1
    fra2
    am6
    dc13
    ch3
    da3
    da11
    la4
    ny5
    sg1
    sv15

    VolumeAttachment, VolumeAttachmentArgs

    Href string
    Href string
    href string
    href String
    href string
    href str
    href String

    VolumeSnapshotPolicy, VolumeSnapshotPolicyArgs

    Package Details

    Repository
    Equinix Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the metal Terraform Provider.
    equinix-metal logo equinix-metal logo Equinix Metal

    This package is deprecated. Equinix has shut down the Equinix Metal service.

    Viewing docs for Equinix Metal v3.2.1
    published on Thursday, Dec 30, 2021 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial