Docs Packages
  1. Packages
  2. Civo
  3. API Docs
  4. VolumeAttachment
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
pulumi/pulumi-civo

civo.VolumeAttachment

Explore with Pulumi AI

civo logo
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
pulumi/pulumi-civo

    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)
    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 string
    The unique name of the resource.
    args VolumeAttachmentArgs
    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 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 string
    The unique name of the resource.
    args VolumeAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := civo.NewVolumeAttachment(ctx, "volumeAttachmentResource", &civo.VolumeAttachmentArgs{
	InstanceId: pulumi.String("string"),
	VolumeId:   pulumi.String("string"),
	Region:     pulumi.String("string"),
})

    var volumeAttachmentResource = new VolumeAttachment("volumeAttachmentResource", VolumeAttachmentArgs.builder()
    .instanceId("string")
    .volumeId("string")
    .region("string")
    .build());

    volume_attachment_resource = civo.VolumeAttachment("volumeAttachmentResource",
    instance_id="string",
    volume_id="string",
    region="string")

    const volumeAttachmentResource = new civo.VolumeAttachment("volumeAttachmentResource", {
    instanceId: "string",
    volumeId: "string",
    region: "string",
});

    type: civo:VolumeAttachment
properties:
    instanceId: string
    region: 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

    The VolumeAttachment resource accepts the following input properties:

    InstanceId string
    The ID of target instance for attachment
    VolumeId string
    The ID of target volume for attachment
    Region string
    The region for the volume attachment
    InstanceId string
    The ID of target instance for attachment
    VolumeId string
    The ID of target volume for attachment
    Region string
    The region for the volume attachment
    instanceId String
    The ID of target instance for attachment
    volumeId String
    The ID of target volume for attachment
    region String
    The region for the volume attachment
    instanceId string
    The ID of target instance for attachment
    volumeId string
    The ID of target volume for attachment
    region string
    The region for the volume attachment
    instance_id str
    The ID of target instance for attachment
    volume_id str
    The ID of target volume for attachment
    region str
    The region for the volume attachment
    instanceId String
    The ID of target instance for attachment
    volumeId String
    The ID of target volume for attachment
    region String
    The region for the volume attachment

    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_id: Optional[str] = None) -> VolumeAttachment
    func 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)
    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:
    InstanceId string
    The ID of target instance for attachment
    Region string
    The region for the volume attachment
    VolumeId string
    The ID of target volume for attachment
    InstanceId string
    The ID of target instance for attachment
    Region string
    The region for the volume attachment
    VolumeId string
    The ID of target volume for attachment
    instanceId String
    The ID of target instance for attachment
    region String
    The region for the volume attachment
    volumeId String
    The ID of target volume for attachment
    instanceId string
    The ID of target instance for attachment
    region string
    The region for the volume attachment
    volumeId 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_id str
    The ID of target volume for attachment
    instanceId String
    The ID of target instance for attachment
    region String
    The region for the volume attachment
    volumeId String
    The ID of target volume for attachment

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
    pulumi/pulumi-civo