This package is deprecated. Equinix has shut down the Equinix Metal service.
published on Thursday, Dec 30, 2021 by Pulumi
This package is deprecated. Equinix has shut down the Equinix Metal service.
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:
- Facility
string | Pulumi.
Equinix Metal. Facility - Plan string
- Project
Id string - Size int
- Billing
Cycle string | Pulumi.Equinix Metal. Billing Cycle - Description string
- Locked bool
- Snapshot
Policies List<Pulumi.Equinix Metal. Inputs. Volume Snapshot Policy>
- Facility string | Facility
- Plan string
- Project
Id string - Size int
- Billing
Cycle string | BillingCycle - Description string
- Locked bool
- Snapshot
Policies []VolumeSnapshot Policy Args
- facility string | "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"
- plan string
- project_
id string - size number
- billing_
cycle string | "hourly" | "monthly" - description string
- locked bool
- snapshot_
policies list(object)
- facility String | Facility
- plan String
- project
Id String - size Integer
- billing
Cycle String | BillingCycle - description String
- locked Boolean
- snapshot
Policies List<VolumeSnapshot Policy>
- facility string | Facility
- plan string
- project
Id string - size number
- billing
Cycle string | BillingCycle - description string
- locked boolean
- snapshot
Policies VolumeSnapshot Policy[]
- facility str | Facility
- plan str
- project_
id str - size int
- billing_
cycle str | BillingCycle - description str
- locked bool
- snapshot_
policies Sequence[VolumeSnapshot Policy Args]
- facility String | "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"
- plan String
- project
Id String - size Number
- billing
Cycle String | "hourly" | "monthly" - description String
- locked Boolean
- snapshot
Policies List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:
- Attachments
List<Pulumi.
Equinix Metal. Outputs. Volume Attachment> - Created string
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- State string
- Updated string
- Attachments
[]Volume
Attachment Type - 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<Volume
Attachment> - created String
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- state String
- updated String
- attachments
Volume
Attachment[] - created string
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- state string
- updated string
- attachments
Sequence[Volume
Attachment] - 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) -> Volumefunc 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.
- Attachments
List<Pulumi.
Equinix Metal. Inputs. Volume Attachment> - Billing
Cycle string | Pulumi.Equinix Metal. Billing Cycle - Created string
- Description string
- Facility
string | Pulumi.
Equinix Metal. Facility - Locked bool
- Name string
- Plan string
- Project
Id string - Size int
- Snapshot
Policies List<Pulumi.Equinix Metal. Inputs. Volume Snapshot Policy> - State string
- Updated string
- Attachments
[]Volume
Attachment Type Args - Billing
Cycle string | BillingCycle - Created string
- Description string
- Facility string | Facility
- Locked bool
- Name string
- Plan string
- Project
Id string - Size int
- Snapshot
Policies []VolumeSnapshot Policy Args - State string
- Updated string
- attachments list(object)
- billing_
cycle string | "hourly" | "monthly" - created string
- description string
- facility string | "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"
- locked bool
- name string
- plan string
- project_
id string - size number
- snapshot_
policies list(object) - state string
- updated string
- attachments
List<Volume
Attachment> - billing
Cycle String | BillingCycle - created String
- description String
- facility String | Facility
- locked Boolean
- name String
- plan String
- project
Id String - size Integer
- snapshot
Policies List<VolumeSnapshot Policy> - state String
- updated String
- attachments
Volume
Attachment[] - billing
Cycle string | BillingCycle - created string
- description string
- facility string | Facility
- locked boolean
- name string
- plan string
- project
Id string - size number
- snapshot
Policies VolumeSnapshot Policy[] - state string
- updated string
- attachments
Sequence[Volume
Attachment Args] - billing_
cycle str | BillingCycle - created str
- description str
- facility str | Facility
- locked bool
- name str
- plan str
- project_
id str - size int
- snapshot_
policies Sequence[VolumeSnapshot Policy Args] - state str
- updated str
- attachments List<Property Map>
- billing
Cycle String | "hourly" | "monthly" - created String
- description String
- facility String | "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"
- locked Boolean
- name String
- plan String
- project
Id String - size Number
- snapshot
Policies List<Property Map> - state String
- updated String
Supporting Types
BillingCycle, BillingCycleArgs
| Name | Value |
|---|---|
| Hourly | hourly |
| Monthly | monthly |
| Name | Value |
|---|---|
| Billing | hourly |
| Billing | monthly |
| Value |
|---|
hourly |
monthly |
| Name | Value |
|---|---|
| Hourly | hourly |
| Monthly | monthly |
| Name | Value |
|---|---|
| Hourly | hourly |
| Monthly | monthly |
| Name | Value |
|---|---|
| HOURLY | hourly |
| MONTHLY | monthly |
| Value |
|---|
hourly |
monthly |
Facility, FacilityArgs
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| Facility | ewr1 |
| Facility | sjc1 |
| Facility | dfw1 |
| Facility | dfw2 |
| Facility | ams1 |
| Facility | nrt1 |
| Facility | sea1 |
| Facility | lax1 |
| Facility | ord1 |
| Facility | atl1 |
| Facility | iad1 |
| Facility | sin1 |
| Facility | hkg1 |
| Facility | syd1 |
| Facility | mrs1 |
| Facility | yyz1 |
| Facility | fra2 |
| Facility | am6 |
| Facility | dc13 |
| Facility | ch3 |
| Facility | da3 |
| Facility | da11 |
| Facility | la4 |
| Facility | ny5 |
| Facility | sg1 |
| Facility | sv15 |
| 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 |
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| 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 |
| 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
- Snapshot
Count int - Snapshot
Frequency string
- Snapshot
Count int - Snapshot
Frequency string
- snapshot_
count number - snapshot_
frequency string
- snapshot
Count Integer - snapshot
Frequency String
- snapshot
Count number - snapshot
Frequency string
- snapshot_
count int - snapshot_
frequency str
- snapshot
Count Number - snapshot
Frequency String
Package Details
- Repository
- Equinix Metal pulumi/pulumi-equinix-metal
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
metalTerraform Provider.
This package is deprecated. Equinix has shut down the Equinix Metal service.
published on Thursday, Dec 30, 2021 by Pulumi