1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. Volume

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

equinix-metal.Volume

Explore with Pulumi AI

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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
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. VolumeArgs
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. 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",
        },
    },
});
Copy
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"),
		},
	},
})
Copy
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());
Copy
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",
    }])
Copy
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",
    }],
});
Copy
type: equinix-metal:Volume
properties:
    billingCycle: string
    description: string
    facility: string
    locked: false
    plan: string
    projectId: string
    size: 0
    snapshotPolicies:
        - snapshotCount: 0
          snapshotFrequency: string
Copy

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:

Facility This property is required. string | Pulumi.EquinixMetal.Facility
Plan This property is required. string
ProjectId This property is required. string
Size This property is required. int
BillingCycle string | Pulumi.EquinixMetal.BillingCycle
Description string
Locked bool
SnapshotPolicies List<Pulumi.EquinixMetal.Inputs.VolumeSnapshotPolicy>
Facility This property is required. string | Facility
Plan This property is required. string
ProjectId This property is required. string
Size This property is required. int
BillingCycle string | BillingCycle
Description string
Locked bool
SnapshotPolicies []VolumeSnapshotPolicyArgs
facility This property is required. String | Facility
plan This property is required. String
projectId This property is required. String
size This property is required. Integer
billingCycle String | BillingCycle
description String
locked Boolean
snapshotPolicies List<VolumeSnapshotPolicy>
facility This property is required. string | Facility
plan This property is required. string
projectId This property is required. string
size This property is required. number
billingCycle string | BillingCycle
description string
locked boolean
snapshotPolicies VolumeSnapshotPolicy[]
facility This property is required. str | Facility
plan This property is required. str
project_id This property is required. str
size This property is required. int
billing_cycle str | BillingCycle
description str
locked bool
snapshot_policies Sequence[VolumeSnapshotPolicyArgs]

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<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:  _:    type: equinix-metal:Volume    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:

Supporting Types

BillingCycle
, BillingCycleArgs

Hourly
hourly
Monthly
monthly
BillingCycleHourly
hourly
BillingCycleMonthly
monthly
Hourly
hourly
Monthly
monthly
Hourly
hourly
Monthly
monthly
HOURLY
hourly
MONTHLY
monthly
"hourly"
hourly
"monthly"
monthly

Facility
, FacilityArgs

EWR1
ewr1
SJC1
sjc1
DFW1
dfw1
DFW2
dfw2
AMS1
ams1
NRT1
nrt1
SEA1
sea1
LAX1
lax1
ORD1
ord1
ATL1
atl1
IAD1
iad1
SIN1
sin1
HKG1
hkg1
SYD1
syd1
MRS1
mrs1
YYZ1
yyz1
FRA2
fra2
AM6
am6
DC13
dc13
CH3
ch3
DA3
da3
DA11
da11
LA4
la4
NY5
ny5
SG1
sg1
SV15
sv15
FacilityEWR1
ewr1
FacilitySJC1
sjc1
FacilityDFW1
dfw1
FacilityDFW2
dfw2
FacilityAMS1
ams1
FacilityNRT1
nrt1
FacilitySEA1
sea1
FacilityLAX1
lax1
FacilityORD1
ord1
FacilityATL1
atl1
FacilityIAD1
iad1
FacilitySIN1
sin1
FacilityHKG1
hkg1
FacilitySYD1
syd1
FacilityMRS1
mrs1
FacilityYYZ1
yyz1
FacilityFRA2
fra2
FacilityAM6
am6
FacilityDC13
dc13
FacilityCH3
ch3
FacilityDA3
da3
FacilityDA11
da11
FacilityLA4
la4
FacilityNY5
ny5
FacilitySG1
sg1
FacilitySV15
sv15
EWR1
ewr1
SJC1
sjc1
DFW1
dfw1
DFW2
dfw2
AMS1
ams1
NRT1
nrt1
SEA1
sea1
LAX1
lax1
ORD1
ord1
ATL1
atl1
IAD1
iad1
SIN1
sin1
HKG1
hkg1
SYD1
syd1
MRS1
mrs1
YYZ1
yyz1
FRA2
fra2
AM6
am6
DC13
dc13
CH3
ch3
DA3
da3
DA11
da11
LA4
la4
NY5
ny5
SG1
sg1
SV15
sv15
EWR1
ewr1
SJC1
sjc1
DFW1
dfw1
DFW2
dfw2
AMS1
ams1
NRT1
nrt1
SEA1
sea1
LAX1
lax1
ORD1
ord1
ATL1
atl1
IAD1
iad1
SIN1
sin1
HKG1
hkg1
SYD1
syd1
MRS1
mrs1
YYZ1
yyz1
FRA2
fra2
AM6
am6
DC13
dc13
CH3
ch3
DA3
da3
DA11
da11
LA4
la4
NY5
ny5
SG1
sg1
SV15
sv15
EWR1
ewr1
SJC1
sjc1
DFW1
dfw1
DFW2
dfw2
AMS1
ams1
NRT1
nrt1
SEA1
sea1
LAX1
lax1
ORD1
ord1
ATL1
atl1
IAD1
iad1
SIN1
sin1
HKG1
hkg1
SYD1
syd1
MRS1
mrs1
YYZ1
yyz1
FRA2
fra2
AM6
am6
DC13
dc13
CH3
ch3
DA3
da3
DA11
da11
LA4
la4
NY5
ny5
SG1
sg1
SV15
sv15
"ewr1"
ewr1
"sjc1"
sjc1
"dfw1"
dfw1
"dfw2"
dfw2
"ams1"
ams1
"nrt1"
nrt1
"sea1"
sea1
"lax1"
lax1
"ord1"
ord1
"atl1"
atl1
"iad1"
iad1
"sin1"
sin1
"hkg1"
hkg1
"syd1"
syd1
"mrs1"
mrs1
"yyz1"
yyz1
"fra2"
fra2
"am6"
am6
"dc13"
dc13
"ch3"
ch3
"da3"
da3
"da11"
da11
"la4"
la4
"ny5"
ny5
"sg1"
sg1
"sv15"
sv15

VolumeAttachment
, VolumeAttachmentArgs

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

VolumeSnapshotPolicy
, VolumeSnapshotPolicyArgs

SnapshotCount This property is required. int
SnapshotFrequency This property is required. string
SnapshotCount This property is required. int
SnapshotFrequency This property is required. string
snapshotCount This property is required. Integer
snapshotFrequency This property is required. String
snapshotCount This property is required. number
snapshotFrequency This property is required. string
snapshot_count This property is required. int
snapshot_frequency This property is required. str
snapshotCount This property is required. Number
snapshotFrequency This property is required. String

Package Details

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