1. Packages
  2. Openstack Provider
  3. API Docs
  4. blockstorage
  5. QuoteSetV3
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi

openstack.blockstorage.QuoteSetV3

Explore with Pulumi AI

openstack logo
OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi

    Manages a V3 block storage quotaset resource within OpenStack.

    Note: This usually requires admin privileges.

    Note: This resource has a no-op deletion so no actual actions will be done against the OpenStack API in case of delete call.

    Note: This resource has all-in creation so all optional quota arguments that were not specified are created with zero value. This excludes volume type quota.

    Create QuoteSetV3 Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new QuoteSetV3(name: string, args: QuoteSetV3Args, opts?: CustomResourceOptions);
    @overload
    def QuoteSetV3(resource_name: str,
                   args: QuoteSetV3Args,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def QuoteSetV3(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project_id: Optional[str] = None,
                   backup_gigabytes: Optional[int] = None,
                   backups: Optional[int] = None,
                   gigabytes: Optional[int] = None,
                   groups: Optional[int] = None,
                   per_volume_gigabytes: Optional[int] = None,
                   region: Optional[str] = None,
                   snapshots: Optional[int] = None,
                   volume_type_quota: Optional[Mapping[str, str]] = None,
                   volumes: Optional[int] = None)
    func NewQuoteSetV3(ctx *Context, name string, args QuoteSetV3Args, opts ...ResourceOption) (*QuoteSetV3, error)
    public QuoteSetV3(string name, QuoteSetV3Args args, CustomResourceOptions? opts = null)
    public QuoteSetV3(String name, QuoteSetV3Args args)
    public QuoteSetV3(String name, QuoteSetV3Args args, CustomResourceOptions options)
    
    type: openstack:blockstorage:QuoteSetV3
    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 QuoteSetV3Args
    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 QuoteSetV3Args
    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 QuoteSetV3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QuoteSetV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QuoteSetV3Args
    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 quoteSetV3Resource = new OpenStack.BlockStorage.QuoteSetV3("quoteSetV3Resource", new()
    {
        ProjectId = "string",
        BackupGigabytes = 0,
        Backups = 0,
        Gigabytes = 0,
        Groups = 0,
        PerVolumeGigabytes = 0,
        Region = "string",
        Snapshots = 0,
        VolumeTypeQuota = 
        {
            { "string", "string" },
        },
        Volumes = 0,
    });
    
    example, err := blockstorage.NewQuoteSetV3(ctx, "quoteSetV3Resource", &blockstorage.QuoteSetV3Args{
    	ProjectId:          pulumi.String("string"),
    	BackupGigabytes:    pulumi.Int(0),
    	Backups:            pulumi.Int(0),
    	Gigabytes:          pulumi.Int(0),
    	Groups:             pulumi.Int(0),
    	PerVolumeGigabytes: pulumi.Int(0),
    	Region:             pulumi.String("string"),
    	Snapshots:          pulumi.Int(0),
    	VolumeTypeQuota: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Volumes: pulumi.Int(0),
    })
    
    var quoteSetV3Resource = new QuoteSetV3("quoteSetV3Resource", QuoteSetV3Args.builder()
        .projectId("string")
        .backupGigabytes(0)
        .backups(0)
        .gigabytes(0)
        .groups(0)
        .perVolumeGigabytes(0)
        .region("string")
        .snapshots(0)
        .volumeTypeQuota(Map.of("string", "string"))
        .volumes(0)
        .build());
    
    quote_set_v3_resource = openstack.blockstorage.QuoteSetV3("quoteSetV3Resource",
        project_id="string",
        backup_gigabytes=0,
        backups=0,
        gigabytes=0,
        groups=0,
        per_volume_gigabytes=0,
        region="string",
        snapshots=0,
        volume_type_quota={
            "string": "string",
        },
        volumes=0)
    
    const quoteSetV3Resource = new openstack.blockstorage.QuoteSetV3("quoteSetV3Resource", {
        projectId: "string",
        backupGigabytes: 0,
        backups: 0,
        gigabytes: 0,
        groups: 0,
        perVolumeGigabytes: 0,
        region: "string",
        snapshots: 0,
        volumeTypeQuota: {
            string: "string",
        },
        volumes: 0,
    });
    
    type: openstack:blockstorage:QuoteSetV3
    properties:
        backupGigabytes: 0
        backups: 0
        gigabytes: 0
        groups: 0
        perVolumeGigabytes: 0
        projectId: string
        region: string
        snapshots: 0
        volumeTypeQuota:
            string: string
        volumes: 0
    

    QuoteSetV3 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 QuoteSetV3 resource accepts the following input properties:

    ProjectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    BackupGigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    Backups int
    Quota value for backups. Changing this updates the existing quotaset.
    Gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    Groups int
    Quota value for groups. Changing this updates the existing quotaset.
    PerVolumeGigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    Region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    Snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    VolumeTypeQuota Dictionary<string, string>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    Volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    ProjectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    BackupGigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    Backups int
    Quota value for backups. Changing this updates the existing quotaset.
    Gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    Groups int
    Quota value for groups. Changing this updates the existing quotaset.
    PerVolumeGigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    Region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    Snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    VolumeTypeQuota map[string]string
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    Volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    projectId String
    ID of the project to manage quotas. Changing this creates a new quotaset.
    backupGigabytes Integer
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups Integer
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes Integer
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups Integer
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes Integer
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    region String
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots Integer
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota Map<String,String>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes Integer
    Quota value for volumes. Changing this updates the existing quotaset.
    projectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    backupGigabytes number
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups number
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes number
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups number
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes number
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots number
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota {[key: string]: string}
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes number
    Quota value for volumes. Changing this updates the existing quotaset.
    project_id str
    ID of the project to manage quotas. Changing this creates a new quotaset.
    backup_gigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups int
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups int
    Quota value for groups. Changing this updates the existing quotaset.
    per_volume_gigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    region str
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    volume_type_quota Mapping[str, str]
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    projectId String
    ID of the project to manage quotas. Changing this creates a new quotaset.
    backupGigabytes Number
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups Number
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes Number
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups Number
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes Number
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    region String
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots Number
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota Map<String>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes Number
    Quota value for volumes. Changing this updates the existing quotaset.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the QuoteSetV3 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 QuoteSetV3 Resource

    Get an existing QuoteSetV3 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?: QuoteSetV3State, opts?: CustomResourceOptions): QuoteSetV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_gigabytes: Optional[int] = None,
            backups: Optional[int] = None,
            gigabytes: Optional[int] = None,
            groups: Optional[int] = None,
            per_volume_gigabytes: Optional[int] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            snapshots: Optional[int] = None,
            volume_type_quota: Optional[Mapping[str, str]] = None,
            volumes: Optional[int] = None) -> QuoteSetV3
    func GetQuoteSetV3(ctx *Context, name string, id IDInput, state *QuoteSetV3State, opts ...ResourceOption) (*QuoteSetV3, error)
    public static QuoteSetV3 Get(string name, Input<string> id, QuoteSetV3State? state, CustomResourceOptions? opts = null)
    public static QuoteSetV3 get(String name, Output<String> id, QuoteSetV3State 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:
    BackupGigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    Backups int
    Quota value for backups. Changing this updates the existing quotaset.
    Gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    Groups int
    Quota value for groups. Changing this updates the existing quotaset.
    PerVolumeGigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    ProjectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    Region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    Snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    VolumeTypeQuota Dictionary<string, string>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    Volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    BackupGigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    Backups int
    Quota value for backups. Changing this updates the existing quotaset.
    Gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    Groups int
    Quota value for groups. Changing this updates the existing quotaset.
    PerVolumeGigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    ProjectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    Region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    Snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    VolumeTypeQuota map[string]string
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    Volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    backupGigabytes Integer
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups Integer
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes Integer
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups Integer
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes Integer
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    projectId String
    ID of the project to manage quotas. Changing this creates a new quotaset.
    region String
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots Integer
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota Map<String,String>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes Integer
    Quota value for volumes. Changing this updates the existing quotaset.
    backupGigabytes number
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups number
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes number
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups number
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes number
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    projectId string
    ID of the project to manage quotas. Changing this creates a new quotaset.
    region string
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots number
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota {[key: string]: string}
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes number
    Quota value for volumes. Changing this updates the existing quotaset.
    backup_gigabytes int
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups int
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes int
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups int
    Quota value for groups. Changing this updates the existing quotaset.
    per_volume_gigabytes int
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    project_id str
    ID of the project to manage quotas. Changing this creates a new quotaset.
    region str
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots int
    Quota value for snapshots. Changing this updates the existing quotaset.
    volume_type_quota Mapping[str, str]
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes int
    Quota value for volumes. Changing this updates the existing quotaset.
    backupGigabytes Number
    Quota value for backup gigabytes. Changing this updates the existing quotaset.
    backups Number
    Quota value for backups. Changing this updates the existing quotaset.
    gigabytes Number
    Quota value for gigabytes. Changing this updates the existing quotaset.
    groups Number
    Quota value for groups. Changing this updates the existing quotaset.
    perVolumeGigabytes Number
    Quota value for gigabytes per volume . Changing this updates the existing quotaset.
    projectId String
    ID of the project to manage quotas. Changing this creates a new quotaset.
    region String
    The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.
    snapshots Number
    Quota value for snapshots. Changing this updates the existing quotaset.
    volumeTypeQuota Map<String>
    Key/Value pairs for setting quota for volumes types. Possible keys are snapshots_<volume_type_name>, volumes_<volume_type_name> and gigabytes_<volume_type_name>.
    volumes Number
    Quota value for volumes. Changing this updates the existing quotaset.

    Import

    Quotasets can be imported using the project_id/region, e.g.

    $ pulumi import openstack:blockstorage/quoteSetV3:QuoteSetV3 quotaset_1 2a0f2240-c5e6-41de-896d-e80d97428d6b/region_1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.0 published on Friday, Sep 27, 2024 by Pulumi