@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
200 lines (199 loc) • 6.62 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = new meraki.organizations.Licenses("example", {
* deviceSerial: "Q234-ABCD-5678",
* licenseId: "string",
* organizationId: "string",
* });
* export const merakiOrganizationsLicensesExample = example;
* ```
*
* ## Import
*
* ```sh
* $ pulumi import meraki:organizations/licenses:Licenses example "license_id,organization_id"
* ```
*/
export declare class Licenses extends pulumi.CustomResource {
/**
* Get an existing Licenses 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?: LicensesState, opts?: pulumi.CustomResourceOptions): Licenses;
/**
* Returns true if the given object is an instance of Licenses. 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 Licenses;
/**
* The date the license started burning
*/
readonly activationDate: pulumi.Output<string>;
/**
* The date the license was claimed into the organization
*/
readonly claimDate: pulumi.Output<string>;
/**
* Serial number of the device the license is assigned to
*/
readonly deviceSerial: pulumi.Output<string>;
/**
* The duration of the individual license
*/
readonly durationInDays: pulumi.Output<number>;
/**
* The date the license will expire
*/
readonly expirationDate: pulumi.Output<string>;
/**
* The id of the head license this license is queued behind. If there is no head license, it returns nil.
*/
readonly headLicenseId: pulumi.Output<string>;
/**
* licenseId path parameter. License ID
*/
readonly licenseId: pulumi.Output<string>;
/**
* License key
*/
readonly licenseKey: pulumi.Output<string>;
/**
* License type
*/
readonly licenseType: pulumi.Output<string>;
/**
* ID of the network the license is assigned to
*/
readonly networkId: pulumi.Output<string>;
/**
* Order number
*/
readonly orderNumber: pulumi.Output<string>;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId: pulumi.Output<string>;
/**
* DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
*/
readonly permanentlyQueuedLicenses: pulumi.Output<outputs.organizations.LicensesPermanentlyQueuedLicense[]>;
/**
* The number of seats of the license. Only applicable to SM licenses.
*/
readonly seatCount: pulumi.Output<number>;
/**
* The state of the license. All queued licenses have a status of *recentlyQueued*.
*/
readonly state: pulumi.Output<string>;
/**
* The duration of the license plus all permanently queued licenses associated with it
*/
readonly totalDurationInDays: pulumi.Output<number>;
/**
* Create a Licenses 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: LicensesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Licenses resources.
*/
export interface LicensesState {
/**
* The date the license started burning
*/
activationDate?: pulumi.Input<string>;
/**
* The date the license was claimed into the organization
*/
claimDate?: pulumi.Input<string>;
/**
* Serial number of the device the license is assigned to
*/
deviceSerial?: pulumi.Input<string>;
/**
* The duration of the individual license
*/
durationInDays?: pulumi.Input<number>;
/**
* The date the license will expire
*/
expirationDate?: pulumi.Input<string>;
/**
* The id of the head license this license is queued behind. If there is no head license, it returns nil.
*/
headLicenseId?: pulumi.Input<string>;
/**
* licenseId path parameter. License ID
*/
licenseId?: pulumi.Input<string>;
/**
* License key
*/
licenseKey?: pulumi.Input<string>;
/**
* License type
*/
licenseType?: pulumi.Input<string>;
/**
* ID of the network the license is assigned to
*/
networkId?: pulumi.Input<string>;
/**
* Order number
*/
orderNumber?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* DEPRECATED List of permanently queued licenses attached to the license. Instead, use /organizations/{organizationId}/licenses?deviceSerial= to retrieved queued licenses for a given device.
*/
permanentlyQueuedLicenses?: pulumi.Input<pulumi.Input<inputs.organizations.LicensesPermanentlyQueuedLicense>[]>;
/**
* The number of seats of the license. Only applicable to SM licenses.
*/
seatCount?: pulumi.Input<number>;
/**
* The state of the license. All queued licenses have a status of *recentlyQueued*.
*/
state?: pulumi.Input<string>;
/**
* The duration of the license plus all permanently queued licenses associated with it
*/
totalDurationInDays?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Licenses resource.
*/
export interface LicensesArgs {
/**
* Serial number of the device the license is assigned to
*/
deviceSerial?: pulumi.Input<string>;
/**
* licenseId path parameter. License ID
*/
licenseId: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId: pulumi.Input<string>;
}