Docs Home
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo
civo.VolumeAttachment
Explore with Pulumi AI
Manages volume attachment/detachment to an instance.
Create VolumeAttachment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VolumeAttachment(name: string, args: VolumeAttachmentArgs, opts?: CustomResourceOptions);@overload
def VolumeAttachment(resource_name: str,
args: VolumeAttachmentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VolumeAttachment(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
volume_id: Optional[str] = None,
region: Optional[str] = None,
volume_attachment_id: Optional[str] = None)func NewVolumeAttachment(ctx *Context, name string, args VolumeAttachmentArgs, opts ...ResourceOption) (*VolumeAttachment, error)public VolumeAttachment(string name, VolumeAttachmentArgs args, CustomResourceOptions? opts = null)public VolumeAttachment(String name, VolumeAttachmentArgs args)
public VolumeAttachment(String name, VolumeAttachmentArgs args, CustomResourceOptions options)
type: civo:VolumeAttachment
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. VolumeAttachmentArgs - 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. VolumeAttachmentArgs - 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. VolumeAttachmentArgs - 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. VolumeAttachmentArgs - 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. VolumeAttachmentArgs - 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 volumeAttachmentResource = new Civo.VolumeAttachment("volumeAttachmentResource", new()
{
InstanceId = "string",
VolumeId = "string",
Region = "string",
VolumeAttachmentId = "string",
});
example, err := civo.NewVolumeAttachment(ctx, "volumeAttachmentResource", &civo.VolumeAttachmentArgs{
InstanceId: pulumi.String("string"),
VolumeId: pulumi.String("string"),
Region: pulumi.String("string"),
VolumeAttachmentId: pulumi.String("string"),
})
var volumeAttachmentResource = new VolumeAttachment("volumeAttachmentResource", VolumeAttachmentArgs.builder()
.instanceId("string")
.volumeId("string")
.region("string")
.volumeAttachmentId("string")
.build());
volume_attachment_resource = civo.VolumeAttachment("volumeAttachmentResource",
instance_id="string",
volume_id="string",
region="string",
volume_attachment_id="string")
const volumeAttachmentResource = new civo.VolumeAttachment("volumeAttachmentResource", {
instanceId: "string",
volumeId: "string",
region: "string",
volumeAttachmentId: "string",
});
type: civo:VolumeAttachment
properties:
instanceId: string
region: string
volumeAttachmentId: string
volumeId: string
VolumeAttachment 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 VolumeAttachment resource accepts the following input properties:
- Instance
Id This property is required. string - The ID of target instance for attachment
- Volume
Id This property is required. string - The ID of target volume for attachment
- Region string
- The region for the volume attachment
- Volume
Attachment stringId - The ID of this resource.
- Instance
Id This property is required. string - The ID of target instance for attachment
- Volume
Id This property is required. string - The ID of target volume for attachment
- Region string
- The region for the volume attachment
- Volume
Attachment stringId - The ID of this resource.
- instance
Id This property is required. String - The ID of target instance for attachment
- volume
Id This property is required. String - The ID of target volume for attachment
- region String
- The region for the volume attachment
- volume
Attachment StringId - The ID of this resource.
- instance
Id This property is required. string - The ID of target instance for attachment
- volume
Id This property is required. string - The ID of target volume for attachment
- region string
- The region for the volume attachment
- volume
Attachment stringId - The ID of this resource.
- instance_
id This property is required. str - The ID of target instance for attachment
- volume_
id This property is required. str - The ID of target volume for attachment
- region str
- The region for the volume attachment
- volume_
attachment_ strid - The ID of this resource.
- instance
Id This property is required. String - The ID of target instance for attachment
- volume
Id This property is required. String - The ID of target volume for attachment
- region String
- The region for the volume attachment
- volume
Attachment StringId - The ID of this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the VolumeAttachment resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing VolumeAttachment Resource
Get an existing VolumeAttachment 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?: VolumeAttachmentState, opts?: CustomResourceOptions): VolumeAttachment@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
region: Optional[str] = None,
volume_attachment_id: Optional[str] = None,
volume_id: Optional[str] = None) -> VolumeAttachmentfunc GetVolumeAttachment(ctx *Context, name string, id IDInput, state *VolumeAttachmentState, opts ...ResourceOption) (*VolumeAttachment, error)public static VolumeAttachment Get(string name, Input<string> id, VolumeAttachmentState? state, CustomResourceOptions? opts = null)public static VolumeAttachment get(String name, Output<String> id, VolumeAttachmentState state, CustomResourceOptions options)resources: _: type: civo:VolumeAttachment 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:
- Instance
Id string - The ID of target instance for attachment
- Region string
- The region for the volume attachment
- Volume
Attachment stringId - The ID of this resource.
- Volume
Id string - The ID of target volume for attachment
- Instance
Id string - The ID of target instance for attachment
- Region string
- The region for the volume attachment
- Volume
Attachment stringId - The ID of this resource.
- Volume
Id string - The ID of target volume for attachment
- instance
Id String - The ID of target instance for attachment
- region String
- The region for the volume attachment
- volume
Attachment StringId - The ID of this resource.
- volume
Id String - The ID of target volume for attachment
- instance
Id string - The ID of target instance for attachment
- region string
- The region for the volume attachment
- volume
Attachment stringId - The ID of this resource.
- volume
Id string - The ID of target volume for attachment
- instance_
id str - The ID of target instance for attachment
- region str
- The region for the volume attachment
- volume_
attachment_ strid - The ID of this resource.
- volume_
id str - The ID of target volume for attachment
- instance
Id String - The ID of target instance for attachment
- region String
- The region for the volume attachment
- volume
Attachment StringId - The ID of this resource.
- volume
Id String - The ID of target volume for attachment
Package Details
- Repository
- Civo civo/terraform-provider-civo
- License
- Notes
- This Pulumi package is based on the
civoTerraform Provider.