@cuemby/equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
149 lines (148 loc) • 4.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Provides a resource to manage organization resource in Equinix Metal.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@pulumi/equinix";
*
* // Create a new Organization
* const tfOrganization1 = new equinix.MetalOrganization("tf_organization_1", {
* description: "quux",
* });
* ```
*
* ## Import
*
* This resource can be imported using an existing organization ID
*
* ```sh
* $ pulumi import equinix:index/metalOrganization:MetalOrganization equinix_metal_organization {existing_organization_id}
* ```
*/
export declare class MetalOrganization extends pulumi.CustomResource {
/**
* Get an existing MetalOrganization 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?: MetalOrganizationState, opts?: pulumi.CustomResourceOptions): MetalOrganization;
/**
* Returns true if the given object is an instance of MetalOrganization. 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 MetalOrganization;
/**
* Postal address.
*/
readonly address: pulumi.Output<outputs.MetalOrganizationAddress>;
/**
* The timestamp for when the organization was created.
*/
readonly created: pulumi.Output<string>;
/**
* Description string.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Logo URL.
*/
readonly logo: pulumi.Output<string | undefined>;
/**
* The name of the Organization.
*/
readonly name: pulumi.Output<string>;
/**
* Twitter handle.
*/
readonly twitter: pulumi.Output<string | undefined>;
/**
* The timestamp for the last time the organization was updated.
*/
readonly updated: pulumi.Output<string>;
/**
* Website link.
*/
readonly website: pulumi.Output<string | undefined>;
/**
* Create a MetalOrganization 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: MetalOrganizationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetalOrganization resources.
*/
export interface MetalOrganizationState {
/**
* Postal address.
*/
address?: pulumi.Input<inputs.MetalOrganizationAddress>;
/**
* The timestamp for when the organization was created.
*/
created?: pulumi.Input<string>;
/**
* Description string.
*/
description?: pulumi.Input<string>;
/**
* Logo URL.
*/
logo?: pulumi.Input<string>;
/**
* The name of the Organization.
*/
name?: pulumi.Input<string>;
/**
* Twitter handle.
*/
twitter?: pulumi.Input<string>;
/**
* The timestamp for the last time the organization was updated.
*/
updated?: pulumi.Input<string>;
/**
* Website link.
*/
website?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetalOrganization resource.
*/
export interface MetalOrganizationArgs {
/**
* Postal address.
*/
address: pulumi.Input<inputs.MetalOrganizationAddress>;
/**
* Description string.
*/
description?: pulumi.Input<string>;
/**
* Logo URL.
*/
logo?: pulumi.Input<string>;
/**
* The name of the Organization.
*/
name?: pulumi.Input<string>;
/**
* Twitter handle.
*/
twitter?: pulumi.Input<string>;
/**
* Website link.
*/
website?: pulumi.Input<string>;
}