1. Packages
  2. Koyeb
  3. API Docs
  4. Volume
Koyeb v0.1.11 published on Monday, Dec 9, 2024 by Koyeb

koyeb.Volume

Explore with Pulumi AI

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,
           max_size: Optional[int] = None,
           region: Optional[str] = None,
           name: Optional[str] = None,
           read_only: Optional[bool] = None,
           volume_type: Optional[str] = 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: koyeb:Volume
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. VolumeArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
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. VolumeArgs
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. 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 Koyeb.Volume("volumeResource", new()
{
    MaxSize = 0,
    Region = "string",
    Name = "string",
    ReadOnly = false,
    VolumeType = "string",
});
Copy
example, err := koyeb.NewVolume(ctx, "volumeResource", &koyeb.VolumeArgs{
	MaxSize:    pulumi.Int(0),
	Region:     pulumi.String("string"),
	Name:       pulumi.String("string"),
	ReadOnly:   pulumi.Bool(false),
	VolumeType: pulumi.String("string"),
})
Copy
var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .maxSize(0)
    .region("string")
    .name("string")
    .readOnly(false)
    .volumeType("string")
    .build());
Copy
volume_resource = koyeb.Volume("volumeResource",
    max_size=0,
    region="string",
    name="string",
    read_only=False,
    volume_type="string")
Copy
const volumeResource = new koyeb.Volume("volumeResource", {
    maxSize: 0,
    region: "string",
    name: "string",
    readOnly: false,
    volumeType: "string",
});
Copy
type: koyeb:Volume
properties:
    maxSize: 0
    name: string
    readOnly: false
    region: string
    volumeType: string
Copy

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:

MaxSize
This property is required.
Changes to this property will trigger replacement.
int
The maximum size of the volume in GB
Region
This property is required.
Changes to this property will trigger replacement.
string
The region where the volume is located
Name string
The volume name
ReadOnly bool
If set to true, the volume will be mounted in read-only
VolumeType string
The volume type
MaxSize
This property is required.
Changes to this property will trigger replacement.
int
The maximum size of the volume in GB
Region
This property is required.
Changes to this property will trigger replacement.
string
The region where the volume is located
Name string
The volume name
ReadOnly bool
If set to true, the volume will be mounted in read-only
VolumeType string
The volume type
maxSize
This property is required.
Changes to this property will trigger replacement.
Integer
The maximum size of the volume in GB
region
This property is required.
Changes to this property will trigger replacement.
String
The region where the volume is located
name String
The volume name
readOnly Boolean
If set to true, the volume will be mounted in read-only
volumeType String
The volume type
maxSize
This property is required.
Changes to this property will trigger replacement.
number
The maximum size of the volume in GB
region
This property is required.
Changes to this property will trigger replacement.
string
The region where the volume is located
name string
The volume name
readOnly boolean
If set to true, the volume will be mounted in read-only
volumeType string
The volume type
max_size
This property is required.
Changes to this property will trigger replacement.
int
The maximum size of the volume in GB
region
This property is required.
Changes to this property will trigger replacement.
str
The region where the volume is located
name str
The volume name
read_only bool
If set to true, the volume will be mounted in read-only
volume_type str
The volume type
maxSize
This property is required.
Changes to this property will trigger replacement.
Number
The maximum size of the volume in GB
region
This property is required.
Changes to this property will trigger replacement.
String
The region where the volume is located
name String
The volume name
readOnly Boolean
If set to true, the volume will be mounted in read-only
volumeType String
The volume type

Outputs

All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

BackingStore string
The backing store of the volume
CreatedAt string
The date and time of when the volume was created
CurSize int
The current size of the volume in GB
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The organization ID owning the volume
ServiceId string
The service ID the volume is attached to
SnapshotId string
The snapshot ID the volume was created from
Status string
The status of the volume
UpdatedAt string
The date and time of when the volume was last updated
BackingStore string
The backing store of the volume
CreatedAt string
The date and time of when the volume was created
CurSize int
The current size of the volume in GB
Id string
The provider-assigned unique ID for this managed resource.
OrganizationId string
The organization ID owning the volume
ServiceId string
The service ID the volume is attached to
SnapshotId string
The snapshot ID the volume was created from
Status string
The status of the volume
UpdatedAt string
The date and time of when the volume was last updated
backingStore String
The backing store of the volume
createdAt String
The date and time of when the volume was created
curSize Integer
The current size of the volume in GB
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The organization ID owning the volume
serviceId String
The service ID the volume is attached to
snapshotId String
The snapshot ID the volume was created from
status String
The status of the volume
updatedAt String
The date and time of when the volume was last updated
backingStore string
The backing store of the volume
createdAt string
The date and time of when the volume was created
curSize number
The current size of the volume in GB
id string
The provider-assigned unique ID for this managed resource.
organizationId string
The organization ID owning the volume
serviceId string
The service ID the volume is attached to
snapshotId string
The snapshot ID the volume was created from
status string
The status of the volume
updatedAt string
The date and time of when the volume was last updated
backing_store str
The backing store of the volume
created_at str
The date and time of when the volume was created
cur_size int
The current size of the volume in GB
id str
The provider-assigned unique ID for this managed resource.
organization_id str
The organization ID owning the volume
service_id str
The service ID the volume is attached to
snapshot_id str
The snapshot ID the volume was created from
status str
The status of the volume
updated_at str
The date and time of when the volume was last updated
backingStore String
The backing store of the volume
createdAt String
The date and time of when the volume was created
curSize Number
The current size of the volume in GB
id String
The provider-assigned unique ID for this managed resource.
organizationId String
The organization ID owning the volume
serviceId String
The service ID the volume is attached to
snapshotId String
The snapshot ID the volume was created from
status String
The status of the volume
updatedAt String
The date and time of when the volume was last updated

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,
        backing_store: Optional[str] = None,
        created_at: Optional[str] = None,
        cur_size: Optional[int] = None,
        max_size: Optional[int] = None,
        name: Optional[str] = None,
        organization_id: Optional[str] = None,
        read_only: Optional[bool] = None,
        region: Optional[str] = None,
        service_id: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        status: Optional[str] = None,
        updated_at: Optional[str] = None,
        volume_type: 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)
resources:  _:    type: koyeb:Volume    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:
BackingStore string
The backing store of the volume
CreatedAt string
The date and time of when the volume was created
CurSize int
The current size of the volume in GB
MaxSize Changes to this property will trigger replacement. int
The maximum size of the volume in GB
Name string
The volume name
OrganizationId string
The organization ID owning the volume
ReadOnly bool
If set to true, the volume will be mounted in read-only
Region Changes to this property will trigger replacement. string
The region where the volume is located
ServiceId string
The service ID the volume is attached to
SnapshotId string
The snapshot ID the volume was created from
Status string
The status of the volume
UpdatedAt string
The date and time of when the volume was last updated
VolumeType string
The volume type
BackingStore string
The backing store of the volume
CreatedAt string
The date and time of when the volume was created
CurSize int
The current size of the volume in GB
MaxSize Changes to this property will trigger replacement. int
The maximum size of the volume in GB
Name string
The volume name
OrganizationId string
The organization ID owning the volume
ReadOnly bool
If set to true, the volume will be mounted in read-only
Region Changes to this property will trigger replacement. string
The region where the volume is located
ServiceId string
The service ID the volume is attached to
SnapshotId string
The snapshot ID the volume was created from
Status string
The status of the volume
UpdatedAt string
The date and time of when the volume was last updated
VolumeType string
The volume type
backingStore String
The backing store of the volume
createdAt String
The date and time of when the volume was created
curSize Integer
The current size of the volume in GB
maxSize Changes to this property will trigger replacement. Integer
The maximum size of the volume in GB
name String
The volume name
organizationId String
The organization ID owning the volume
readOnly Boolean
If set to true, the volume will be mounted in read-only
region Changes to this property will trigger replacement. String
The region where the volume is located
serviceId String
The service ID the volume is attached to
snapshotId String
The snapshot ID the volume was created from
status String
The status of the volume
updatedAt String
The date and time of when the volume was last updated
volumeType String
The volume type
backingStore string
The backing store of the volume
createdAt string
The date and time of when the volume was created
curSize number
The current size of the volume in GB
maxSize Changes to this property will trigger replacement. number
The maximum size of the volume in GB
name string
The volume name
organizationId string
The organization ID owning the volume
readOnly boolean
If set to true, the volume will be mounted in read-only
region Changes to this property will trigger replacement. string
The region where the volume is located
serviceId string
The service ID the volume is attached to
snapshotId string
The snapshot ID the volume was created from
status string
The status of the volume
updatedAt string
The date and time of when the volume was last updated
volumeType string
The volume type
backing_store str
The backing store of the volume
created_at str
The date and time of when the volume was created
cur_size int
The current size of the volume in GB
max_size Changes to this property will trigger replacement. int
The maximum size of the volume in GB
name str
The volume name
organization_id str
The organization ID owning the volume
read_only bool
If set to true, the volume will be mounted in read-only
region Changes to this property will trigger replacement. str
The region where the volume is located
service_id str
The service ID the volume is attached to
snapshot_id str
The snapshot ID the volume was created from
status str
The status of the volume
updated_at str
The date and time of when the volume was last updated
volume_type str
The volume type
backingStore String
The backing store of the volume
createdAt String
The date and time of when the volume was created
curSize Number
The current size of the volume in GB
maxSize Changes to this property will trigger replacement. Number
The maximum size of the volume in GB
name String
The volume name
organizationId String
The organization ID owning the volume
readOnly Boolean
If set to true, the volume will be mounted in read-only
region Changes to this property will trigger replacement. String
The region where the volume is located
serviceId String
The service ID the volume is attached to
snapshotId String
The snapshot ID the volume was created from
status String
The status of the volume
updatedAt String
The date and time of when the volume was last updated
volumeType String
The volume type

Package Details

Repository
koyeb koyeb/pulumi-koyeb
License
Apache-2.0
Notes
This Pulumi package is based on the koyeb Terraform Provider.