equinix-metal logo
Equinix Metal v3.2.1, Dec 30 21

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

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           billing_cycle: Optional[Union[str, BillingCycle]] = None,
           description: Optional[str] = None,
           facility: Optional[Union[str, Facility]] = None,
           locked: Optional[bool] = None,
           plan: Optional[str] = None,
           project_id: Optional[str] = None,
           size: Optional[int] = None,
           snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None)
@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = 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.

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.

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

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<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)
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:

Supporting Types

BillingCycle

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

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

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

VolumeSnapshotPolicy

Package Details

Repository
Equinix Metal pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes

This Pulumi package is based on the metal Terraform Provider.