@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
228 lines (227 loc) • 7.77 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V2 Neutron QoS policy resource within OpenStack.
*
* ## Example Usage
*
* ### Create a QoS Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const qosPolicy1 = new openstack.networking.QosPolicy("qos_policy_1", {
* name: "qos_policy_1",
* description: "bw_limit",
* });
* ```
*
* ## Import
*
* QoS Policies can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import openstack:networking/qosPolicy:QosPolicy qos_policy_1 d6ae28ce-fcb5-4180-aa62-d260a27e09ae
* ```
*/
export declare class QosPolicy extends pulumi.CustomResource {
/**
* Get an existing QosPolicy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosPolicyState, opts?: pulumi.CustomResourceOptions): QosPolicy;
/**
* Returns true if the given object is an instance of QosPolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is QosPolicy;
/**
* The collection of tags assigned on the QoS policy, which have been
* explicitly and implicitly added.
*/
readonly allTags: pulumi.Output<string[]>;
/**
* The time at which QoS policy was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The human-readable description for the QoS policy.
* Changing this updates the description of the existing QoS policy.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Indicates whether the QoS policy is default
* QoS policy or not. Changing this updates the default status of the existing
* QoS policy.
*/
readonly isDefault: pulumi.Output<boolean | undefined>;
/**
* The name of the QoS policy. Changing this updates the name of
* the existing QoS policy.
*/
readonly name: pulumi.Output<string>;
/**
* The owner of the QoS policy. Required if admin wants to
* create a QoS policy for another project. Changing this creates a new QoS policy.
*/
readonly projectId: pulumi.Output<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron Qos policy. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* QoS policy.
*/
readonly region: pulumi.Output<string>;
/**
* The revision number of the QoS policy.
*/
readonly revisionNumber: pulumi.Output<number>;
/**
* Indicates whether this QoS policy is shared across
* all projects. Changing this updates the shared status of the existing
* QoS policy.
*/
readonly shared: pulumi.Output<boolean | undefined>;
/**
* A set of string tags for the QoS policy.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The time at which QoS policy was created.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Map of additional options.
*/
readonly valueSpecs: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Create a QosPolicy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: QosPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering QosPolicy resources.
*/
export interface QosPolicyState {
/**
* The collection of tags assigned on the QoS policy, which have been
* explicitly and implicitly added.
*/
allTags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The time at which QoS policy was created.
*/
createdAt?: pulumi.Input<string>;
/**
* The human-readable description for the QoS policy.
* Changing this updates the description of the existing QoS policy.
*/
description?: pulumi.Input<string>;
/**
* Indicates whether the QoS policy is default
* QoS policy or not. Changing this updates the default status of the existing
* QoS policy.
*/
isDefault?: pulumi.Input<boolean>;
/**
* The name of the QoS policy. Changing this updates the name of
* the existing QoS policy.
*/
name?: pulumi.Input<string>;
/**
* The owner of the QoS policy. Required if admin wants to
* create a QoS policy for another project. Changing this creates a new QoS policy.
*/
projectId?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron Qos policy. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* QoS policy.
*/
region?: pulumi.Input<string>;
/**
* The revision number of the QoS policy.
*/
revisionNumber?: pulumi.Input<number>;
/**
* Indicates whether this QoS policy is shared across
* all projects. Changing this updates the shared status of the existing
* QoS policy.
*/
shared?: pulumi.Input<boolean>;
/**
* A set of string tags for the QoS policy.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The time at which QoS policy was created.
*/
updatedAt?: pulumi.Input<string>;
/**
* Map of additional options.
*/
valueSpecs?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a QosPolicy resource.
*/
export interface QosPolicyArgs {
/**
* The human-readable description for the QoS policy.
* Changing this updates the description of the existing QoS policy.
*/
description?: pulumi.Input<string>;
/**
* Indicates whether the QoS policy is default
* QoS policy or not. Changing this updates the default status of the existing
* QoS policy.
*/
isDefault?: pulumi.Input<boolean>;
/**
* The name of the QoS policy. Changing this updates the name of
* the existing QoS policy.
*/
name?: pulumi.Input<string>;
/**
* The owner of the QoS policy. Required if admin wants to
* create a QoS policy for another project. Changing this creates a new QoS policy.
*/
projectId?: pulumi.Input<string>;
/**
* The region in which to obtain the V2 Networking client.
* A Networking client is needed to create a Neutron Qos policy. If omitted, the
* `region` argument of the provider is used. Changing this creates a new
* QoS policy.
*/
region?: pulumi.Input<string>;
/**
* Indicates whether this QoS policy is shared across
* all projects. Changing this updates the shared status of the existing
* QoS policy.
*/
shared?: pulumi.Input<boolean>;
/**
* A set of string tags for the QoS policy.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Map of additional options.
*/
valueSpecs?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}