@pulumi/gcp/networksecurity/sacRealm.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Secure Access Connect Realm resource
 *
 * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
 * See Provider Versions for more details on beta resources.
 *
 * To get more information about SacRealm, see:
 *
 * * [API documentation](https://cloud.google.com/secure-access-connect/docs/reference/network-security/rest/v1beta1/projects.locations.sacRealms)
 * * How-to Guides
 *     * [QUICKSTART_TITLE](https://cloud.google.com/secure-access-connect/docs/overview)
 *
 * ## Example Usage
 *
 * ### Sac Realm Prisma Access
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.networksecurity.SacRealm("default", {
 *     name: "sac-realm-name",
 *     labels: {
 *         "label-one": "value-one",
 *     },
 *     securityService: "PALO_ALTO_PRISMA_ACCESS",
 * });
 * ```
 * ### Sac Realm Symantec Cloud Swg
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.networksecurity.SacRealm("default", {
 *     name: "sac-realm-name",
 *     labels: {
 *         "label-one": "value-one",
 *     },
 *     securityService: "SYMANTEC_CLOUD_SWG",
 *     symantecOptions: {
 *         secretPath: "secret-path",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * SacRealm can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/global/sacRealms/{{name}}`
 * * `{{project}}/{{name}}`
 * * `{{name}}`
 *
 * When using the `pulumi import` command, SacRealm can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:networksecurity/sacRealm:SacRealm default projects/{{project}}/locations/global/sacRealms/{{name}}
 * $ pulumi import gcp:networksecurity/sacRealm:SacRealm default {{project}}/{{name}}
 * $ pulumi import gcp:networksecurity/sacRealm:SacRealm default {{name}}
 * ```
 */
export declare class SacRealm extends pulumi.CustomResource {
    /**
     * Get an existing SacRealm 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?: SacRealmState, opts?: pulumi.CustomResourceOptions): SacRealm;
    /**
     * Returns true if the given object is an instance of SacRealm.  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 SacRealm;
    /**
     * Timestamp when the realm was created.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Identifier. Resource name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Key to be shared with SSE service provider during pairing.
     * Structure is documented below.
     */
    readonly pairingKeys: pulumi.Output<outputs.networksecurity.SacRealmPairingKey[]>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * SSE service provider associated with the realm.
     * Possible values are: `SECURITY_SERVICE_UNSPECIFIED`, `PALO_ALTO_PRISMA_ACCESS`, `SYMANTEC_CLOUD_SWG`.
     */
    readonly securityService: pulumi.Output<string>;
    /**
     * State of the realm.
     */
    readonly state: pulumi.Output<string>;
    /**
     * Configuration required for Symantec realms.
     * Structure is documented below.
     */
    readonly symantecOptions: pulumi.Output<outputs.networksecurity.SacRealmSymantecOptions | undefined>;
    /**
     * Timestamp when the realm was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a SacRealm 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: SacRealmArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SacRealm resources.
 */
export interface SacRealmState {
    /**
     * Timestamp when the realm was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Identifier. Resource name.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * Key to be shared with SSE service provider during pairing.
     * Structure is documented below.
     */
    pairingKeys?: pulumi.Input<pulumi.Input<inputs.networksecurity.SacRealmPairingKey>[] | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * SSE service provider associated with the realm.
     * Possible values are: `SECURITY_SERVICE_UNSPECIFIED`, `PALO_ALTO_PRISMA_ACCESS`, `SYMANTEC_CLOUD_SWG`.
     */
    securityService?: pulumi.Input<string | undefined>;
    /**
     * State of the realm.
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * Configuration required for Symantec realms.
     * Structure is documented below.
     */
    symantecOptions?: pulumi.Input<inputs.networksecurity.SacRealmSymantecOptions | undefined>;
    /**
     * Timestamp when the realm was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a SacRealm resource.
 */
export interface SacRealmArgs {
    /**
     * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
     * When a 'terraform destroy' or 'pulumi up' would delete the resource,
     * the command will fail if this field is set to "PREVENT" in Terraform state.
     * When set to "ABANDON", the command will remove the resource from Terraform
     * management without updating or deleting the resource in the API.
     * When set to "DELETE", deleting the resource is allowed.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Identifier. Resource name.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * SSE service provider associated with the realm.
     * Possible values are: `SECURITY_SERVICE_UNSPECIFIED`, `PALO_ALTO_PRISMA_ACCESS`, `SYMANTEC_CLOUD_SWG`.
     */
    securityService: pulumi.Input<string>;
    /**
     * Configuration required for Symantec realms.
     * Structure is documented below.
     */
    symantecOptions?: pulumi.Input<inputs.networksecurity.SacRealmSymantecOptions | undefined>;
}
//# sourceMappingURL=sacRealm.d.ts.map