Docs Home
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 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 Koyeb.Volume("volumeResource", new()
{
MaxSize = 0,
Region = "string",
Name = "string",
ReadOnly = false,
VolumeType = "string",
});
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"),
})
var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
.maxSize(0)
.region("string")
.name("string")
.readOnly(false)
.volumeType("string")
.build());
volume_resource = koyeb.Volume("volumeResource",
max_size=0,
region="string",
name="string",
read_only=False,
volume_type="string")
const volumeResource = new koyeb.Volume("volumeResource", {
maxSize: 0,
region: "string",
name: "string",
readOnly: false,
volumeType: "string",
});
type: koyeb:Volume
properties:
maxSize: 0
name: string
readOnly: false
region: string
volumeType: 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:
- Max
Size int - The maximum size of the volume in GB
- Region string
- The region where the volume is located
- Name string
- The volume name
- Read
Only bool - If set to true, the volume will be mounted in read-only
- Volume
Type string - The volume type
- Max
Size int - The maximum size of the volume in GB
- Region string
- The region where the volume is located
- Name string
- The volume name
- Read
Only bool - If set to true, the volume will be mounted in read-only
- Volume
Type string - The volume type
- max
Size Integer - The maximum size of the volume in GB
- region String
- The region where the volume is located
- name String
- The volume name
- read
Only Boolean - If set to true, the volume will be mounted in read-only
- volume
Type String - The volume type
- max
Size number - The maximum size of the volume in GB
- region string
- The region where the volume is located
- name string
- The volume name
- read
Only boolean - If set to true, the volume will be mounted in read-only
- volume
Type string - The volume type
- max_
size int - The maximum size of the volume in GB
- region 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
- max
Size Number - The maximum size of the volume in GB
- region String
- The region where the volume is located
- name String
- The volume name
- read
Only Boolean - If set to true, the volume will be mounted in read-only
- volume
Type String - The volume type
Outputs
All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:
- Backing
Store string - The backing store of the volume
- Created
At string - The date and time of when the volume was created
- Cur
Size int - The current size of the volume in GB
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The organization ID owning the volume
- Service
Id string - The service ID the volume is attached to
- Snapshot
Id string - The snapshot ID the volume was created from
- Status string
- The status of the volume
- Updated
At string - The date and time of when the volume was last updated
- Backing
Store string - The backing store of the volume
- Created
At string - The date and time of when the volume was created
- Cur
Size int - The current size of the volume in GB
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The organization ID owning the volume
- Service
Id string - The service ID the volume is attached to
- Snapshot
Id string - The snapshot ID the volume was created from
- Status string
- The status of the volume
- Updated
At string - The date and time of when the volume was last updated
- backing
Store String - The backing store of the volume
- created
At String - The date and time of when the volume was created
- cur
Size Integer - The current size of the volume in GB
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The organization ID owning the volume
- service
Id String - The service ID the volume is attached to
- snapshot
Id String - The snapshot ID the volume was created from
- status String
- The status of the volume
- updated
At String - The date and time of when the volume was last updated
- backing
Store string - The backing store of the volume
- created
At string - The date and time of when the volume was created
- cur
Size number - The current size of the volume in GB
- id string
- The provider-assigned unique ID for this managed resource.
- organization
Id string - The organization ID owning the volume
- service
Id string - The service ID the volume is attached to
- snapshot
Id string - The snapshot ID the volume was created from
- status string
- The status of the volume
- updated
At 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
- backing
Store String - The backing store of the volume
- created
At String - The date and time of when the volume was created
- cur
Size Number - The current size of the volume in GB
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The organization ID owning the volume
- service
Id String - The service ID the volume is attached to
- snapshot
Id String - The snapshot ID the volume was created from
- status String
- The status of the volume
- updated
At 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) -> 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: _: type: koyeb:Volume get: id: ${id}- 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.
- Backing
Store string - The backing store of the volume
- Created
At string - The date and time of when the volume was created
- Cur
Size int - The current size of the volume in GB
- Max
Size int - The maximum size of the volume in GB
- Name string
- The volume name
- Organization
Id string - The organization ID owning the volume
- Read
Only bool - If set to true, the volume will be mounted in read-only
- Region string
- The region where the volume is located
- Service
Id string - The service ID the volume is attached to
- Snapshot
Id string - The snapshot ID the volume was created from
- Status string
- The status of the volume
- Updated
At string - The date and time of when the volume was last updated
- Volume
Type string - The volume type
- Backing
Store string - The backing store of the volume
- Created
At string - The date and time of when the volume was created
- Cur
Size int - The current size of the volume in GB
- Max
Size int - The maximum size of the volume in GB
- Name string
- The volume name
- Organization
Id string - The organization ID owning the volume
- Read
Only bool - If set to true, the volume will be mounted in read-only
- Region string
- The region where the volume is located
- Service
Id string - The service ID the volume is attached to
- Snapshot
Id string - The snapshot ID the volume was created from
- Status string
- The status of the volume
- Updated
At string - The date and time of when the volume was last updated
- Volume
Type string - The volume type
- backing
Store String - The backing store of the volume
- created
At String - The date and time of when the volume was created
- cur
Size Integer - The current size of the volume in GB
- max
Size Integer - The maximum size of the volume in GB
- name String
- The volume name
- organization
Id String - The organization ID owning the volume
- read
Only Boolean - If set to true, the volume will be mounted in read-only
- region String
- The region where the volume is located
- service
Id String - The service ID the volume is attached to
- snapshot
Id String - The snapshot ID the volume was created from
- status String
- The status of the volume
- updated
At String - The date and time of when the volume was last updated
- volume
Type String - The volume type
- backing
Store string - The backing store of the volume
- created
At string - The date and time of when the volume was created
- cur
Size number - The current size of the volume in GB
- max
Size number - The maximum size of the volume in GB
- name string
- The volume name
- organization
Id string - The organization ID owning the volume
- read
Only boolean - If set to true, the volume will be mounted in read-only
- region string
- The region where the volume is located
- service
Id string - The service ID the volume is attached to
- snapshot
Id string - The snapshot ID the volume was created from
- status string
- The status of the volume
- updated
At string - The date and time of when the volume was last updated
- volume
Type 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 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 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
- backing
Store String - The backing store of the volume
- created
At String - The date and time of when the volume was created
- cur
Size Number - The current size of the volume in GB
- max
Size Number - The maximum size of the volume in GB
- name String
- The volume name
- organization
Id String - The organization ID owning the volume
- read
Only Boolean - If set to true, the volume will be mounted in read-only
- region String
- The region where the volume is located
- service
Id String - The service ID the volume is attached to
- snapshot
Id String - The snapshot ID the volume was created from
- status String
- The status of the volume
- updated
At String - The date and time of when the volume was last updated
- volume
Type String - The volume type
Package Details
- Repository
- koyeb koyeb/pulumi-koyeb
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
koyebTerraform Provider.