@formalco/pulumi/satellite.d.ts

A Pulumi package for creating and managing Formal resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Registering a Satellite
 */
export declare class Satellite extends pulumi.CustomResource {
    /**
     * Get an existing Satellite 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?: SatelliteState, opts?: pulumi.CustomResourceOptions): Satellite;
    /**
     * Returns true if the given object is an instance of Satellite.  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 Satellite;
    /**
     * Api key of the Satellite.
     */
    readonly apiKey: pulumi.Output<string>;
    /**
     * Friendly name for the Satellite.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the Space to create the Satellite in.
     */
    readonly spaceId: pulumi.Output<string | undefined>;
    /**
     * If set to true, this Satellite cannot be deleted.
     */
    readonly terminationProtection: pulumi.Output<boolean | undefined>;
    /**
     * TLS certificate of the Satellite.
     */
    readonly tlsCert: pulumi.Output<string>;
    /**
     * Create a Satellite 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?: SatelliteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Satellite resources.
 */
export interface SatelliteState {
    /**
     * Api key of the Satellite.
     */
    apiKey?: pulumi.Input<string>;
    /**
     * Friendly name for the Satellite.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Space to create the Satellite in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * If set to true, this Satellite cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
    /**
     * TLS certificate of the Satellite.
     */
    tlsCert?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Satellite resource.
 */
export interface SatelliteArgs {
    /**
     * Friendly name for the Satellite.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the Space to create the Satellite in.
     */
    spaceId?: pulumi.Input<string>;
    /**
     * If set to true, this Satellite cannot be deleted.
     */
    terminationProtection?: pulumi.Input<boolean>;
}