Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Volume

Create a Volume Resource

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
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)
func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

Volume Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Volume resource accepts the following input properties:

Facility string | Pulumi.EquinixMetal.Facility

The facility to create the volume in

Plan string

The service plan slug of the volume

ProjectId string

The metal project ID to deploy the volume in

Size int

The size in GB to make the volume

BillingCycle string | Pulumi.EquinixMetal.BillingCycle

The billing cycle, defaults to “hourly”

Description string

Optional description for the volume

Locked bool

Lock or unlock the volume

SnapshotPolicies List<Pulumi.EquinixMetal.Inputs.VolumeSnapshotPolicyArgs>

Optional list of snapshot policies

Facility string | Facility

The facility to create the volume in

Plan string

The service plan slug of the volume

ProjectId string

The metal project ID to deploy the volume in

Size int

The size in GB to make the volume

BillingCycle string | BillingCycle

The billing cycle, defaults to “hourly”

Description string

Optional description for the volume

Locked bool

Lock or unlock the volume

SnapshotPolicies []VolumeSnapshotPolicy

Optional list of snapshot policies

facility string | Facility

The facility to create the volume in

plan string

The service plan slug of the volume

projectId string

The metal project ID to deploy the volume in

size number

The size in GB to make the volume

billingCycle string | BillingCycle

The billing cycle, defaults to “hourly”

description string

Optional description for the volume

locked boolean

Lock or unlock the volume

snapshotPolicies VolumeSnapshotPolicy[]

Optional list of snapshot policies

facility str | Facility

The facility to create the volume in

plan str

The service plan slug of the volume

project_id str

The metal project ID to deploy the volume in

size int

The size in GB to make the volume

billing_cycle str | BillingCycle

The billing cycle, defaults to “hourly”

description str

Optional description for the volume

locked bool

Lock or unlock the volume

snapshot_policies Sequence[VolumeSnapshotPolicyArgs]

Optional list of snapshot policies

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>

A list of attachments, each with it’s own href attribute

Created string

The timestamp for when the volume was created

Id string
The provider-assigned unique ID for this managed resource.
Name string

The name of the volume

State string

The state of the volume

Updated string

The timestamp for the last time the volume was updated

Attachments []VolumeAttachmentType

A list of attachments, each with it’s own href attribute

Created string

The timestamp for when the volume was created

Id string
The provider-assigned unique ID for this managed resource.
Name string

The name of the volume

State string

The state of the volume

Updated string

The timestamp for the last time the volume was updated

attachments VolumeAttachment[]

A list of attachments, each with it’s own href attribute

created string

The timestamp for when the volume was created

id string
The provider-assigned unique ID for this managed resource.
name string

The name of the volume

state string

The state of the volume

updated string

The timestamp for the last time the volume was updated

attachments Sequence[VolumeAttachment]

A list of attachments, each with it’s own href attribute

created str

The timestamp for when the volume was created

id str
The provider-assigned unique ID for this managed resource.
name str

The name of the volume

state str

The state of the volume

updated str

The timestamp for the last time the volume was updated

Look up an 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)
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.

The following state arguments are supported:

Attachments List<Pulumi.EquinixMetal.Inputs.VolumeAttachmentArgs>

A list of attachments, each with it’s own href attribute

BillingCycle string | Pulumi.EquinixMetal.BillingCycle

The billing cycle, defaults to “hourly”

Created string

The timestamp for when the volume was created

Description string

Optional description for the volume

Facility string | Pulumi.EquinixMetal.Facility

The facility to create the volume in

Locked bool

Lock or unlock the volume

Name string

The name of the volume

Plan string

The service plan slug of the volume

ProjectId string

The metal project ID to deploy the volume in

Size int

The size in GB to make the volume

SnapshotPolicies List<Pulumi.EquinixMetal.Inputs.VolumeSnapshotPolicyArgs>

Optional list of snapshot policies

State string

The state of the volume

Updated string

The timestamp for the last time the volume was updated

Attachments []VolumeAttachmentType

A list of attachments, each with it’s own href attribute

BillingCycle string | BillingCycle

The billing cycle, defaults to “hourly”

Created string

The timestamp for when the volume was created

Description string

Optional description for the volume

Facility string | Facility

The facility to create the volume in

Locked bool

Lock or unlock the volume

Name string

The name of the volume

Plan string

The service plan slug of the volume

ProjectId string

The metal project ID to deploy the volume in

Size int

The size in GB to make the volume

SnapshotPolicies []VolumeSnapshotPolicy

Optional list of snapshot policies

State string

The state of the volume

Updated string

The timestamp for the last time the volume was updated

attachments VolumeAttachment[]

A list of attachments, each with it’s own href attribute

billingCycle string | BillingCycle

The billing cycle, defaults to “hourly”

created string

The timestamp for when the volume was created

description string

Optional description for the volume

facility string | Facility

The facility to create the volume in

locked boolean

Lock or unlock the volume

name string

The name of the volume

plan string

The service plan slug of the volume

projectId string

The metal project ID to deploy the volume in

size number

The size in GB to make the volume

snapshotPolicies VolumeSnapshotPolicy[]

Optional list of snapshot policies

state string

The state of the volume

updated string

The timestamp for the last time the volume was updated

attachments Sequence[VolumeAttachmentArgs]

A list of attachments, each with it’s own href attribute

billing_cycle str | BillingCycle

The billing cycle, defaults to “hourly”

created str

The timestamp for when the volume was created

description str

Optional description for the volume

facility str | Facility

The facility to create the volume in

locked bool

Lock or unlock the volume

name str

The name of the volume

plan str

The service plan slug of the volume

project_id str

The metal project ID to deploy the volume in

size int

The size in GB to make the volume

snapshot_policies Sequence[VolumeSnapshotPolicyArgs]

Optional list of snapshot policies

state str

The state of the volume

updated str

The timestamp for the last time the volume was updated

Supporting Types

BillingCycle

Hourly
hourly
Monthly
monthly
BillingCycleHourly
hourly
BillingCycleMonthly
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

VolumeAttachment

Href string
Href string
href string
href str

VolumeSnapshotPolicy

Package Details

Repository
https://github.com/pulumi/pulumi-equinix-metal
License
Apache-2.0
Notes
This Pulumi package is based on the metal Terraform Provider.